Contributing

This site is the living home of the Sketch FG product specification. Treat documentation with the same rigor as code.

Workflow

1. Clone the repository and install dependencies:

   git clone https://github.com/Sketch-fg/sketch-fg-docs.git
   cd sketch-fg-docs
   pnpm install

2. Start the local preview:

   pnpm run dev   # http://localhost:4321

3. Edit Markdown/MDX files under src/content/docs/.
4. Push directly to main (current team workflow).

Conventions

• Language: English only — the product is English-only.
• Source of truth: the written specification always prevails over reference images. Sample names, prices, and labels in mockups are illustrative unless confirmed in the spec.
• Frontmatter: every page needs title and description (used for SEO and search).
• Links: prefer relative internal links (/spec/catalog/).
• Screenshots: upload approved images to public/screenshots/ as NN-screen-name-context.png (see public/screenshots/README.md). Pages render a placeholder frame until the image exists.
• Spec source tags: spec pages carry a > Source: Master Spec v2.0, §N. quote — keep it accurate when editing.
• Changelog: record notable documentation changes in Changelog.

Checks

pnpm run check    # type checking
pnpm run build    # production build (must pass)
pnpm run format   # Prettier formatting

Deploying

The site deploys to Cloudflare Workers:

pnpm run deploy   # requires `wrangler login`

Set the site URL in astro.config.mjs once the Workers URL or custom domain is known.