Skip to content

Commit 12078aa

Browse files
committed
Fix review comments
1 parent 18e024b commit 12078aa

2 files changed

Lines changed: 7 additions & 8 deletions

File tree

.github/instructions/docs.instructions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Review documentation for Duende Software products (IdentityServer, BFF, etc.). F
2424

2525
## Frontmatter
2626

27-
* Must have `title`, `description`, and `date` (YYYY-MM-DD format).
27+
* Must have `title`, `description`, and `date`. Prefer `YYYY-MM-DD`, but do not flag other Astro/Starlight-accepted date formats already used in this repo (for example, full ISO 8601 timestamps).
2828
* May have `sidebar` with `label` and `order`. For long `title`, the `label` is used as a shorter entry in the navigation bar, and should be shorter than `title`.
2929

3030
## Linking Rules
@@ -33,7 +33,7 @@ Review documentation for Duende Software products (IdentityServer, BFF, etc.). F
3333
* Internal links must start at the content root (e.g. `/identityserver/troubleshooting/index.md`) and include the `.md` or `.mdx` extension.
3434
* External links must use HTTPS.
3535
* Link relevant text: prefer `learn more about [improving sign-in]` over `click [here]`.
36-
* Long links (75+ chars) or repeated links should use reference-style links/link definitions at the bottom of the file (for example, `[label]: https://example.com`).
36+
* Long links (75+ chars) or repeated links should use markdown anchor syntax at the bottom of the file.
3737
* When linking externally, include a sentence about what the reader will find.
3838

3939
## Markdown Style
@@ -44,14 +44,14 @@ Review documentation for Duende Software products (IdentityServer, BFF, etc.). F
4444

4545
## Code Blocks
4646

47-
* Use triple backticks with a language identifier (`csharp`, `bash`, `json`, `html`, `javascript`, `typescript`, `css`).
47+
* Use triple backticks with an appropriate language identifier. Common identifiers used in this repo include `csharp`, `bash`, `powershell`, `shell`, `sh`, `json`, `html`, `javascript`, `typescript`, `css`, `razor`, `xml`, `sql`, `sqlite`, `txt`, `diff`, and `mermaid`.
4848
* Prefer `csharp` over `cs` for C#.
4949
* Add a title as a comment in the first line (e.g. `// Program.cs`).
5050
* Code should not require horizontal scrolling — keep it concise.
5151
* C# examples should use latest syntax (top-level statements, collection expressions).
5252
* Examples should be runnable and complete — "copy-paste from docs" is the goal.
5353
* Use backticks for inline references to properties, classes, symbols, and values (including HTTP status codes like `404`).
54-
* Code blocks must start at column 0 with no excessive leading whitespace.
54+
* Avoid excessive indentation in code blocks; use column 0 unless indentation is needed to nest under lists or MDX components.
5555
* Mention NuGet packages with `dotnet add package ...` in a `bash` block and link to the NuGet Gallery.
5656

5757
## Redirects

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -140,12 +140,11 @@ WebStorm has Grazie as a built-in spell checker and grammar checker, and support
140140
* Use `*` for lists. Do not use `-`.
141141
* Use `[link title](https://example.com)` for links, avoid reference-style links unless you need to repeat the same link multiple times.
142142
* For internal links, always include the extension (e.g. `.md` or `.mdx`)
143-
* Prefer `csharp` over `cs` to set the language for C# code blocks.
144143

145144
### Code Block Style
146145

147-
* Use triple backticks to enclose code blocks.
148-
* Use a language identifier to specify the language (e.g. `csharp`, `bash`, `json`, `html`, `javascript`, `typescript`, `css`, `json`)
146+
* Use triple backticks with an appropriate language identifier. Common identifiers used in this repo include `csharp`, `bash`, `powershell`, `shell`, `sh`, `json`, `html`, `javascript`, `typescript`, `css`, `razor`, `xml`, `sql`, `sqlite`, `txt`, `diff`, and `mermaid`.
147+
* Prefer `csharp` over `cs` to set the language for C# code blocks.
149148
* Add a title to the code block. You can do this adding the title as a comment in the first line of the code block (e.g. `// Program.cs`).
150149
* Use [expressive code features](https://starlight.astro.build/guides/authoring-content/#expressive-code-features).
151150
* Readers should not need to scroll horizontally to read a code example. Simplify and condense the code as much as possible.
@@ -155,7 +154,7 @@ WebStorm has Grazie as a built-in spell checker and grammar checker, and support
155154
* Mention NuGet packages as a `bash` code block showing how to install it (`dotnet add package ...`). Link to the NuGet Gallery.
156155
* When referencing a property, field, class, or other symbol in text, use the `test` format instead of _test_.
157156
* Values should also be back-ticked, especially HTTP Status codes like `404` or `401`.
158-
* Make sure code blocks start at the very first character space and don't have excessive starting padding.
157+
* Avoid excessive indentation in code blocks; use column 0 unless indentation is needed to nest under lists or MDX components.
159158

160159
### Frontmatter Rules
161160

0 commit comments

Comments
 (0)