Publish Docs

Runbook

Keep content edits small enough to validate quickly.

Treat docs changes like product changes. Small, deliberate updates are easier to review, build, and rollback than giant content drops.

Preconditions

• dependencies are installed
• you know which page or section you are updating
• the content builds locally

Workflow

1. Edit or add the page under src/content/docs/.
2. If it is a new page, add it to the sidebar in astro.config.mjs.
3. Run a production build.
4. Preview locally if the change needs a visual check.
5. Push the branch when the result looks right, or run a manual Pages deploy if you need one.

Build

npm run build

Preview

npm run preview

Ship

git push origin <branch-name>

Deploy

npm run deploy

Validation still matters on docs sites.

Check that the page lands in the right sidebar section, links resolve, search still works after a real build, and Cloudflare Pages finishes the new deploy before you share the URL.

Use the Pages command, not the Workers command.

wrangler deploy targets Cloudflare Workers. This repo is set up for Cloudflare Pages, so the correct manual deploy path is npm run deploy which runs wrangler pages deploy. If you need server features later, plan that as a separate project change instead of mixing it into routine docs publishing.