Documentation

If you want to improve docs, guides, wording, examples, or structure, this page is for you.

Docs Project Setup

The docs site is an Astro + Starlight project located at:

<root>/docs/app-docs

From the repository root, switch into the docs project first:

cd docs/app-docs

Install dependencies:

npm install

Start local development server:

npm run dev

Build the site:

npm run build

Preview the production build locally:

npm run preview

Where To Edit

Docs content lives under:

src/content/docs/

You can contribute by:

• Fixing typos, grammar, and clarity.
• Adding missing setup or troubleshooting details.
• Improving step-by-step guides.
• Updating screenshots and examples when behavior changes.

Pull Request Checklist

Before opening your PR:

• Ensure your pages render correctly in npm run dev.
• Run npm run build to make sure the site compiles.
• Add a clear PR description of what changed and why.

Small and focused documentation pull requests are always welcome.