Skip to main content
Version: Next 🚧

Release Process

The documentation site should now be part of the release conversation, even though it does not ship inside the app binary.

Release expectations​

Each release should verify:

  • install and setup steps still match reality
  • feature documentation reflects user-visible changes
  • technical docs reflect architecture-visible changes
  • release notes or changelog entries are updated
  • confirm the Docusaurus site builds cleanly
  • review broken links before publishing
  • update homepage messaging when a release changes the product story
  • make sure GitHub Pages deployment succeeds after merge

Future evolution​

As the project matures, this section can expand to include:

  • tagged release notes
  • docs versioning strategy
  • deprecation guidance
  • upgrade notes between app releases