docs: document the self-update flow (README + user manual)#450
Merged
Conversation
The update flow had no user-facing docs — the README went straight from install to quick-start with no "how do I update?" answer, and the user manual had no update page. - New docs/user-manual/updating.md — the canonical guide: `uffs --update` (auto-reconcile to a complete latest core set), check/doctor/repair/recover/ bins, version pinning + rollback via `apply --version`, the health-check redirect, WinGet delegation, and edge cases (stdio MCP, Windows broker, unsigned binaries). - README: new "Updating" section after Download & Install + a Documentation table row. - User-manual index: linked the new page in the reading order. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
1 participant
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.
The update flow had no user-facing docs — the README jumped from install to
quick-start with no "how do I update?", and the user manual had no update page.
Documents the behavior shipped in #446–#449.
docs/user-manual/updating.md— canonical guide:uffs --update(auto-reconcile to a complete latest core set from any starting state),
check/doctor/repair/recover/bins, version pinning + rollback viaapply --version, the doctor→update redirect, WinGet delegation, and edgecases (stdio MCP, Windows broker, unsigned binaries).
table row.
Docs-only.