gameplane / docs
DEVELOP

Public website and docs development

Extend the Astro marketing site and MDX documentation while preserving navigation, canonical URLs, accessibility, and the Pencil source.

Local Developmentv0.214 MIN
Submodule workflow

The website is a separately versioned submodule; merge there first, then bump the gitlink in the main repository.

Site architecture

Astro pages, shared layouts/components, content collections, and the docs navigation module form the public-site contract.

Marketing routesMarketing routes live under website/src/pages.
Docs MDXDocs MDX lives in website/src/content/docs with a shared DocsLayout.
Centralized configNavigation, footer, canonical URLs, icons, and config are centralized.

Develop and verify

Run the submodule locally, validate every static route, and check responsive, keyboard, contrast, metadata, and link behavior.

Install and startInstall with npm ci and run the Astro development server.
Build validationBuild before review to catch collection and route errors.
Test coverageTest docs sidebar, previous/next, search states, mobile layouts, and 404.

Publish a docs change

Update Pencil first for visual changes, edit MDX and navigation together, merge the website repo, then bump and verify the submodule.

WEBSITE LOOP

01   01 cd website && npm ci && npm run dev
02   02 npm run build # validate static routes and content
03   03 Merge website PR → bump submodule pointer → verify public links