docs: add upgrade guide for existing deployments - #254
Open
BlueX888 wants to merge 1 commit into
Open
Conversation
Closes OpenBMB#194. Adds docs/upgrade-guide.md covering packaged desktop and source-deployment upgrades (backup locations, commands, verification, rollback) and links it from a new FAQ entry in both READMEs. Co-Authored-By: Claude Fable 5 <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.
Closes #194.
What: Adds
docs/upgrade-guide.mdcovering upgrades for both packaged desktop installs and source deployments (backup locations, step-by-step commands, verification, rollback), and links it from a new FAQ entry inREADME.md/README.zh.md.Why: #194 asks for an upgrade guide; the repo currently has none. Details are verified against the code: data directories from
backend/app/paths.py, automatic SQLite schema migration frombackend/app/db/database.py, dev scripts/port/health endpoint fromscripts/.How verified: Docs-only change — checked all relative links resolve,
<details>blocks stay balanced in both READMEs, and commands match the current scripts. Note:/docs/is gitignored; the new file is force-added the same way the five existing tracked docs were.🤖 Generated with Claude Code