Ship and maintain

Contributing

Keep changes focused, test the docs app, and make the starter easy for other people to reuse.

This starter is meant to be easy to fork, edit, and publish. Keep contributions simple and broadly useful.

Contribution workflow

  1. Create a branch.
  2. Make one focused change.
  3. Update docs when behavior changes.
  4. Run local checks.
  5. Open a pull request with a short summary.

Local checks

Run:

bash
npm run type-check
npm run build

If your change touches search, AI, MCP, Markdown routes, or navigation, also run npm run dev and test the affected flow in a browser.

Writing style

  • Use active voice.
  • Write to the reader as "you".
  • Keep examples concrete.
  • Prefer short pages with clear headings.
  • Use sentence case for headings.
  • Bold UI labels such as Deploy.
  • Use code formatting for commands, file names, paths, and environment variables.

What belongs in the starter

Good contributions improve the reusable template itself: content patterns, docs components, search, accessibility, configuration, deployment guidance, and project setup.

Avoid adding company-specific copy, paid-service assumptions, internal workflows, or product-specific terminology.