Skip to content

feat: update naming convention docs - #32

Open
LinKCoding wants to merge 9 commits into
mainfrom
kl-gmt-1801-naming-convention-docs
Open

LinKCoding wants to merge 9 commits into
mainfrom
kl-gmt-1801-naming-convention-docs

Conversation

@LinKCoding

@LinKCoding LinKCoding commented Oct 1, 2026 •

Copy link
Copy Markdown
Contributor

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.

  • Extracted naming conventions, code comments, file structure/naming, formatting, linking, and code-reference sections out of contributing-to-gamut.md into a new packages/gamut-docs/src/content/docs/guides/writing-guidance.md guide (authored first as .mdx, then renamed to plain .md since it has no MDX components).
  • Rewrote contributing-to-gamut.md's component/story documentation section to reflect the Starlight site's actual workflow (Storybook autodocs instead of hand-authored .mdx docs, StoryEmbed/FigmaEmbed component-page conventions, sidebar registration notes).
  • Added 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.
  • Registered the new guide in packages/gamut-docs/astro.config.mjs's sidebar and linked it from guides/index.md and concepts/index.md.
  • Synced .claude/skills/gamut-writing/references/docs-in-code.md naming guidance to match the updated conventions (principles ordering, component props rules, RTL/logical-property rule).

PR Checklist

  • Related to designs:
  • Related to JIRA ticket: GMT-1801
  • Changeset added (or empty changeset if no release)
  • I have run this code to verify it works
  • This PR includes unit tests for the code change
  • This PR includes testing instructions tests for the code change
  • Package previews from this PR are passing end-to-end tests in all relevant consuming repositories

Testing Instructions

Don't make me tap the sign.

  1. Run yarn start:docs (or yarn start)
  2. Visit /guides/writing-guidance/ — confirm the naming, comment, formatting, and linking sections render correctly and the page appears in the Guides sidebar.
  3. Visit /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.
  4. (Optionally) Open .claude/skills/gamut-writing/references/docs-in-code.md and confirm its Naming section matches the same principles and ordering as the contributing guide.
  5. (Optionally) Invoke the gamut-writing skill 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

Repository PR Link
Monolith Monolith PR
Mono Mono PR

@pkg-pr-new

pkg-pr-new Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

Open in StackBlitz

@skillsoft/eslint-plugin-gamut

npm i https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/eslint-plugin-gamut@32
yarn add https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/eslint-plugin-gamut@32.tgz

@skillsoft/gamut

npm i https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut@32
yarn add https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut@32.tgz

@skillsoft/gamut-agent-tools

npm i https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut-agent-tools@32
yarn add https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut-agent-tools@32.tgz

@skillsoft/gamut-icons

npm i https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut-icons@32
yarn add https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut-icons@32.tgz

@skillsoft/gamut-illustrations

npm i https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut-illustrations@32
yarn add https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut-illustrations@32.tgz

@skillsoft/gamut-patterns

npm i https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut-patterns@32
yarn add https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut-patterns@32.tgz

@skillsoft/gamut-styles

npm i https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut-styles@32
yarn add https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut-styles@32.tgz

@skillsoft/gamut-tests

npm i https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut-tests@32
yarn add https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/gamut-tests@32.tgz

@skillsoft/variance

npm i https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/variance@32
yarn add https://pkg.pr.new/Codecademy/skillsoft-gamut/@skillsoft/variance@32.tgz

commit: 2676e40

@codecov

codecov Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@0987143). Learn more about missing BASE report.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #32   +/-   ##
=======================================
  Coverage        ?   91.40%           
=======================================
  Files           ?      408           
  Lines           ?     6903           
  Branches        ?     2253           
=======================================
  Hits            ?     6310           
  Misses          ?      584           
  Partials        ?        9           
Flag Coverage Δ
pull-request 91.40% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@LinKCoding
LinKCoding marked this pull request as ready for review October 5, 2026 17:42
@LinKCoding
LinKCoding requested a review from a team as a code owner October 5, 2026 17:42

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant