formatting

This commit is contained in:
John Lancaster
2026-06-19 01:29:05 -05:00
parent 964cd6f76d
commit 3347443ca9
27 changed files with 275 additions and 238 deletions
@@ -10,10 +10,10 @@ Use this reference when writing or reviewing docs for clarity, correctness, and
4. Make examples executable and verifiable.
5. Prefer precise language over marketing language.
Primary references:
- Diataxis: https://diataxis.fr/
- Divio documentation system: https://documentation.divio.com/
- Write the Docs guide: https://www.writethedocs.org/guide/
!!! info "Primary references"
- [Diataxis](https://diataxis.fr/)
- [Divio documentation system](https://documentation.divio.com/)
- [Write the Docs guide](https://www.writethedocs.org/guide/)
## Style and Readability
@@ -22,10 +22,10 @@ Primary references:
- Prefer active voice and imperative instructions for task pages.
- Add notes/warnings only for high-impact caveats.
Source links:
- Google developer style: https://developers.google.com/style
- Microsoft Writing Style Guide: https://learn.microsoft.com/style-guide/welcome/
- MDN writing guidelines: https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines
!!! info "Style sources"
- [Google developer style](https://developers.google.com/style)
- [Microsoft Writing Style Guide](https://learn.microsoft.com/style-guide/welcome/)
- [MDN writing guidelines](https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines)
## Task Page Quality Pattern