docs: expand style guide with undocumented conventions#84
Merged
moss-bryophyta merged 1 commit intostyle-guide-v3from Mar 2, 2026
Merged
docs: expand style guide with undocumented conventions#84moss-bryophyta merged 1 commit intostyle-guide-v3from
moss-bryophyta merged 1 commit intostyle-guide-v3from
Conversation
- 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
archie-mckenzie
pushed a commit
that referenced
this pull request
Mar 2, 2026
* Add docs style guide * fix: remove common corrections section from style guide * docs: add note that 'data' is singular * docs: note GT abbreviation usage * fix: remove variable naming conventions section * fix: remove broken links editorial note * fix: clarify callouts are docs-only * docs: move style guide into docs/, scope to docs only * docs: add undocumented style conventions to style guide (#84) - 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> --------- Co-authored-by: moss-bryophyta <261561981+moss-bryophyta@users.noreply.github.com>
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
1 participant
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.
Adds conventions observed across 25+ docs files that were missing from the style guide:
New sections
__DOCS_PATH__,__PACKAGE_NAME__,__FRAMEWORK_NAME__Based on a systematic audit of docs and docs-templates files.