Repository navigation
feat: update naming convention docs - #32
Merged
Merged
Conversation
@skillsoft/eslint-plugin-gamut
@skillsoft/gamut
@skillsoft/gamut-agent-tools
@skillsoft/gamut-icons
@skillsoft/gamut-illustrations
@skillsoft/gamut-patterns
@skillsoft/gamut-styles
@skillsoft/gamut-tests
@skillsoft/variance
commit: |
|
LinKCoding
marked this pull request as ready for review
October 5, 2026 17:42
dreamwasp
approved these changes
Oct 16, 2026
| Use a plain Markdown link for something like an external tool or reference — most renderers already open these in a new tab: | ||
|
|
||
| ```markdown | ||
| [GitHub Repository](https://github.com/Codecademy/gamut) |
LinKCoding
force-pushed
the
kl-gmt-1801-naming-convention-docs
branch
from
October 16, 2026 14:01
2676e40 to
1120940
Compare
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
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.
Overview
Reworks Gamut's naming-convention documentation: the conventions themselves move into a new "Writing guidance" guide, and a new "Naming conventions rationale" concepts page explains the reasoning behind the less self-evident rules.
contributing-to-gamut.mdinto a newpackages/gamut-docs/src/content/docs/guides/writing-guidance.mdguide (authored first as.mdx, then renamed to plain.mdsince it has no MDX components).contributing-to-gamut.md's component/story documentation section to reflect the Starlight site's actual workflow (Storybook autodocs instead of hand-authored.mdxdocs,StoryEmbed/FigmaEmbedcomponent-page conventions, sidebar registration notes).packages/gamut-docs/src/content/docs/concepts/naming-conventions-rationale.md, explaining the "why" behind naming rules (native HTML attribute reuse, enums over exclusive booleans, predominant-state defaults, logical vs. physical properties, interface-vs-implementation naming) with concrete examples from the Gamut component source.packages/gamut-docs/astro.config.mjs's sidebar and linked it fromguides/index.mdandconcepts/index.md..claude/skills/gamut-writing/references/docs-in-code.mdnaming guidance to match the updated conventions (principles ordering, component props rules, RTL/logical-property rule).PR Checklist
Testing Instructions
Don't make me tap the sign.
yarn start:docs(oryarn start)/guides/writing-guidance/— confirm the naming, comment, formatting, and linking sections render correctly and the page appears in the Guides sidebar./concepts/naming-conventions-rationale/— confirm it's listed on/concepts/and each section's code examples (hideLabel,size="sm",leading/trailing, etc.) render with correct formatting..claude/skills/gamut-writing/references/docs-in-code.mdand confirm its Naming section matches the same principles and ordering as the contributing guide.gamut-writingskill on a sample component edit and confirm it now recommends the new Component Props rules (e.g. native HTML attribute names,on-prefixed events).PR Links and Envs