Skip to main content

Write a help page

Add an MDX file under www/docs/guides/, with a title and description at the top. Explain what someone can do, then give the steps using the names shown in Goop. Add the page to the navigation in www/docs/docs.json. Guides are handwritten. A generator does not replace them when the app changes.

Refresh generated references

From the repository root, run:
This refreshes the palette reference from the Rust core and creates the motion embed from www/docs/design/ui-motion.html. Generated files say where they came from. Their surrounding descriptions still need editorial review.

Add a design example

Use Button as a starting point. Describe the state being shown, include a working example, and say whether it ships in the app or is a proposal. Keep the source file beside the example so it can change with the design. To refresh the existing motion gallery, replace www/docs/design/ui-motion.html with the updated self-contained HTML file, then run the generator. It preserves the original controls inside an isolated frame.

Check the writing

Every page gets a Humanizer editorial pass and the repository’s plain-language checks. Keep facts intact, cut filler, and replace jargon with words the reader knows. Automatic checks catch listed patterns; a person still needs to check the meaning and usefulness.
The checks use Vale and Mintlify. Both handwritten pages and generated references are checked.

Preview

Open the address the CLI prints. Check navigation, light and dark mode, search, and the examples you changed. Changes published to the connected branch deploy to this site.