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
- Verify updates by running MarkdownLint. Use `npx --yes markdownlint-cli2 ...`. `--help` is available.
50
+
- For MD013, override the guidance to allow for 120-character lines.
51
+
52
+
## Editing Documentation
53
+
54
+
When updating documentation files, follow these guidelines:
55
+
56
+
- When writing technical documentation, act as a friendly peer engineer helping other developers to understand Grace as a project.
57
+
- When writing product-focused documentation, act as an expert product manager who helps a tech-aware audience understand Grace as a product, and helps end users understand how to use Grace effectively.
58
+
- Use clear, concise language; avoid jargon. The tone should be welcoming and informative.
59
+
- Structure content with headings and subheadings. Intersperse written (paragraph / sentence form) documentation with bullet points for readability.
60
+
- Keep documentation up to date with code changes; review related docs when modifying functionality. Explain all documentation changes clearly, both what is changing, and why it's changing.
61
+
- Show all scripting examples in both (first) PowerShell and (then, second) bash/zsh, where applicable. bash and zsh are always spelled in lowercase. Good example:
0 commit comments