-
Notifications
You must be signed in to change notification settings - Fork 145
Add documentation review guidelines to .github/instructions and align README writing style section
#1075
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
+67
−5
Merged
Add documentation review guidelines to .github/instructions and align README writing style section
#1075
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
cde3d92
Add documentation review guidelines to `.github/instructions` and ali…
maartenba 6972965
Update .github/instructions/docs.instructions.md
maartenba 18e024b
Update .github/instructions/docs.instructions.md
maartenba 12078aa
Fix review comments
maartenba File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| --- | ||
| applyTo: "astro/src/content/**/*.{md,mdx}" | ||
| --- | ||
|
|
||
| # Documentation Review Guidelines | ||
|
|
||
| ## Purpose | ||
|
|
||
| Review documentation for Duende Software products (IdentityServer, BFF, etc.). Focus on writing quality, accuracy, and consistency with the project's authoring standards. | ||
|
|
||
| ## Writing Style | ||
|
|
||
| - Tone: friendly, educational, patient — "a senior engineer sitting next to you helping with your homework." | ||
| - Use active voice. "Enable" not "Enabled" or "Enabling". | ||
| - Use second person: "you" is the reader, "we" is Duende Software. | ||
| - Sentence case in body text. Title Case for titles. | ||
| - Use the Oxford comma. | ||
| - Avoid filler words: "very", "simple", "easy", "just". | ||
| - Prefer plain words: "use" not "utilize", "set up" not "facilitate", "help" not "assist", "about" not "regarding". | ||
| - Keep it concise. Don't pad. Longer isn't better. | ||
| - Explain *why* something works, not just *what* to change. | ||
| - Expand acronyms on first use: "Multi-Factor Authentication (MFA)". | ||
| - If it sounds like a robot wrote it, flag it. | ||
|
|
||
| ## Frontmatter | ||
|
|
||
| - Must have `title`, `description`, and `date` (YYYY-MM-DD format). | ||
| - 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`. | ||
|
|
||
| ## Linking Rules | ||
|
|
||
| - Prefer internal links over external links. | ||
| - Internal links must start at the content root (e.g. `/identityserver/troubleshooting/index.md`) and include the `.md` or `.mdx` extension. | ||
| - External links must use HTTPS. | ||
| - Link relevant text: prefer `learn more about [improving sign-in]` over `click [here]`. | ||
| - Long links (75+ chars) or repeated links should use markdown anchor syntax at the bottom of the file. | ||
| - When linking externally, include a sentence about what the reader will find. | ||
|
|
||
| ## Markdown Style | ||
|
|
||
| - Use `*` for unordered lists, not `-`. | ||
| - Use inline links `[text](url)` unless the link is repeated or very long. | ||
| - Internal links must include the file extension (`.md` or `.mdx`). | ||
|
|
||
| ## Code Blocks | ||
|
|
||
| - Use triple backticks with a language identifier (`csharp`, `bash`, `json`, `html`, `javascript`, `typescript`, `css`). | ||
| - Prefer `csharp` over `cs` for C#. | ||
| - Add a title as a comment in the first line (e.g. `// Program.cs`). | ||
| - Code should not require horizontal scrolling — keep it concise. | ||
| - C# examples should use latest syntax (top-level statements, collection expressions). | ||
| - Examples should be runnable and complete — "copy-paste from docs" is the goal. | ||
| - Use backticks for inline references to properties, classes, symbols, and values (including HTTP status codes like `404`). | ||
| - Code blocks must start at column 0 with no excessive leading whitespace. | ||
| - Mention NuGet packages with `dotnet add package ...` in a `bash` block and link to the NuGet Gallery. | ||
|
|
||
| ## Redirects | ||
|
|
||
| - When a page is moved, check that `redirect_from` frontmatter is present with the old path. | ||
|
maartenba marked this conversation as resolved.
Outdated
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.