gamut icon indicating copy to clipboard operation
gamut copied to clipboard

docs: Add Gamut Style Guide under /Meta

Open LinKCoding opened this issue 2 months ago • 3 comments

Overview

Adds a style guide for documentation purposes

PR Checklist

  • [ ] Related to designs:
  • [X] Related to JIRA ticket: GMT-157
  • [X] I have run this code to verify it works
  • [ ] This PR includes unit tests for the code change
  • [x] This PR includes testing instructions tests for the code change
  • [ ] The alpha package of this PR is passing end-to-end tests in all relevant Codecademy repositories

Testing Instructions

Don't make me tap the sign.

  1. Go to story /?path=/docs/meta-style-guide-about--docs
  2. Check that the links work
  3. Go through the pages and check that guidelines make sense
  4. ...
  5. Finish and do a celebratory dance

PR Links and Envs

N/A

LinKCoding avatar Oct 27 '25 18:10 LinKCoding

View your CI Pipeline Execution ↗ for commit 818c26d36d263bad9ecfaa43a8221d573ed0f8b8


☁️ Nx Cloud last updated this comment at 2025-11-13 21:03:41 UTC

nx-cloud[bot] avatar Oct 27 '25 18:10 nx-cloud[bot]

Another thought: a lot of this guidance would be very useful in an agent instructions/rules/skills file. I often have Cursor help me write docs, and it always seems to format things in ways I don't like, so I end up having to correct it. This guide would be a huge help with that.

For instance:

  • ./.cursor/rules/documentation-style.mdc - for Cursor
  • ./.github/instructions/documentation-style.instructions.md - for GitHub Copilot & VSCode
  • ./CLAUDE.md - for Claude, which just allows for the one file
    • I think Skills would be something like ./skills/documentation/{SKILL,STYLE}.md, where the SKILL.md "imports" the STYLE.md file, but I haven't used that yet.

sh0ji avatar Nov 06 '25 22:11 sh0ji

📬 Published Alpha Packages:

@codecademy/[email protected]

codecademydev avatar Nov 13 '25 21:11 codecademydev