Docs

Changelog And Docs Build Workflow ​

This page describes the current public docs pipeline.

What Happens On A Dev Branch Push ​

When you push local-dev:

  1. GitHub checks out the branch.
  2. VitePress is built from docs/.
  3. The generated site is copied into public/docs/.
  4. GitHub pushes the rebuilt public/docs/ output back to local-dev if needed.

This keeps the tracked production docs bundle aligned with the source docs.

Public Changelog Source ​

The public changelog is curated in:

text
docs/changelog.md

It is not rebuilt from every commit message anymore. This keeps the published changelog aligned with the cleaned v1.0.x release history instead of drifting back into legacy versions or internal workflow noise.

Production Publishing Flow ​

After docs are rebuilt on local-dev:

  1. GitHub prepares filtered-pr-local-dev.
  2. main receives only the production-safe snapshot.
  3. GitHub release packaging includes public/docs/, not the raw docs/ source.

Why This Matters ​

  • /docs/features/, /docs/muse/, and /docs/architect-hub/ must exist in built output
  • production should serve only the built docs bundle
  • the public changelog should match the live release line