Style guide
Writing and formatting conventions for Docsy project documentation.
This project follows Google’s developer documentation style guide, and uses Prettier and Markdownlint to enforce basic formatting rules.
Front matter
- Do not quote string values unless doing so would otherwise cause ambiguity or unintended type interpretation.
- Drop
linkTitlewhen it is the same astitle.
Content
For lists:
- Use periods when list items are complete sentences (including imperative steps).
- Omit periods when list items are fragments, labels, or link-only bullets.
- Keep punctuation consistent within each list. When this isn’t possible, ask the author how they prefer reworking the list item text: e.g., by making all sentences complete.