You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/instructions/docs.instructions.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ Review documentation for Duende Software products (IdentityServer, BFF, etc.). F
24
24
25
25
## Frontmatter
26
26
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).
28
28
* 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`.
29
29
30
30
## Linking Rules
@@ -33,7 +33,7 @@ Review documentation for Duende Software products (IdentityServer, BFF, etc.). F
33
33
* Internal links must start at the content root (e.g. `/identityserver/troubleshooting/index.md`) and include the `.md` or `.mdx` extension.
34
34
* External links must use HTTPS.
35
35
* 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.
37
37
* When linking externally, include a sentence about what the reader will find.
38
38
39
39
## Markdown Style
@@ -44,14 +44,14 @@ Review documentation for Duende Software products (IdentityServer, BFF, etc.). F
44
44
45
45
## Code Blocks
46
46
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`.
48
48
* Prefer `csharp` over `cs` for C#.
49
49
* Add a title as a comment in the first line (e.g. `// Program.cs`).
50
50
* Code should not require horizontal scrolling — keep it concise.
51
51
* C# examples should use latest syntax (top-level statements, collection expressions).
52
52
* Examples should be runnable and complete — "copy-paste from docs" is the goal.
53
53
* 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.
55
55
* Mention NuGet packages with `dotnet add package ...` in a `bash` block and link to the NuGet Gallery.
Copy file name to clipboardExpand all lines: README.md
+3-4Lines changed: 3 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -140,12 +140,11 @@ WebStorm has Grazie as a built-in spell checker and grammar checker, and support
140
140
* Use `*` for lists. Do not use `-`.
141
141
* Use `[link title](https://example.com)` for links, avoid reference-style links unless you need to repeat the same link multiple times.
142
142
* 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.
144
143
145
144
### Code Block Style
146
145
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.
149
148
* 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`).
150
149
* Use [expressive code features](https://starlight.astro.build/guides/authoring-content/#expressive-code-features).
151
150
* 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
155
154
* Mention NuGet packages as a `bash` code block showing how to install it (`dotnet add package ...`). Link to the NuGet Gallery.
156
155
* When referencing a property, field, class, or other symbol in text, use the `test` format instead of _test_.
157
156
* 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.
0 commit comments