Add docs style guide#66
Merged
archie-mckenzie merged 9 commits intomainfrom Mar 2, 2026
Merged
Conversation
archie-mckenzie
approved these changes
Mar 2, 2026
- Sentence case headings, numbered step format - List punctuation rules (fragments vs full sentences) - Oxford comma, em dash avoidance, i.e./e.g. conventions - Callout bold-lead pattern - API ref and guide page structure templates - Common component patterns (tabs, accordions, ✅/❌, TypeTable) - Template placeholder reference - Custom heading anchors Co-authored-by: moss-bryophyta <261561981+moss-bryophyta@users.noreply.github.com>
archie-mckenzie
approved these changes
Mar 2, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Comprehensive style guide based on patterns from all my docs PRs. Covers naming conventions, grammar, formatting, code examples, and structural guidelines.
Draft for team review and refinement.
(Replaces #63, rebased on current main.)