docs: add upgrade-coven guide (guides checkpoint 7)#42
Merged
Conversation
Sixth catalog entry: pre-upgrade state capture, npm/source upgrade, daemon restart, health + apiVersion/capabilities verification, and session-survival check. Flow mirrors daemon/recovery-upgrades.mdx; restart output verified against run_daemon_command. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new Guides-section page that documents a safe Coven upgrade flow as a verified state transition (capture state → upgrade → restart → API/contract verification → session survival), and wires it into the guides nav and validation tooling.
Changes:
- Added a new Upgrade Coven guide with an ordered, verification-driven upgrade procedure and troubleshooting footer.
- Registered the new guide in the Guides catalog and
meta.jsonnavigation. - Extended the Guides docs check script to require the new page and pin key command/endpoint mentions and a required cross-link.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| scripts/check-guides-docs.mjs | Adds upgrade-coven to required guide pages, pins new required mentions, and enforces a recovery-upgrades cross-link. |
| content/docs/guides/upgrade-coven.mdx | New “Upgrade Coven” step-by-step guide covering pre-checks, upgrade paths, daemon restart, health/capabilities verification, and session survival checks. |
| content/docs/guides/meta.json | Registers upgrade-coven in the Guides section page list. |
| content/docs/guides/index.mdx | Adds the Upgrade Coven row as a live link in the guides catalog. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Checkpoint 7 of the guides-section goal, stacked on #41: the Upgrade Coven guide — safe upgrade as a verified state transition, not just a reinstall.
Changes
content/docs/guides/upgrade-coven.mdx— 5 steps: capture live state (sessions --plain,daemon status,--version) → npm/source upgrade →daemon restart(supervisor caveat) → health +apiVersion+ capabilities verification → session-survival check; troubleshooting footer incl. engine pin lagcontent/docs/guides/index.mdx— catalog row linkedcontent/docs/guides/meta.json— page registeredscripts/check-guides-docs.mjs— pins forcoven --version,/api/v1/capabilities,sessions --all --plain, and the recovery-upgrades cross-linkSources
Step order mirrors the upgrade flow in
daemon/recovery-upgrades.mdx(finish sessions → status → install → restart → health → apiVersion → capabilities); restart/stop output strings verified againstrun_daemon_command(../covenmain.rs:2714+); ledger-survival and orphaned-session framing fromdaemon/lifecycle.mdx+recovery-upgrades.mdx.Validation
check-guides-docs,english-only,no-leading-h1,mermaid-parse,validate-links(0 errors) ✅npx fumadocs-mdx+npx tsc --noEmit+npx next build✅ — all six guide pages prerendered