Repository navigation
docs: fix unsafe WAL recovery advice and align docs with milestones - #408
Merged
Merged
Conversation
- ERROR_REFERENCE: WAL-001/WAL-002/STG-011 said deleting the .wal loses no data, or that a database can be rebuilt from the WAL alone. Both are wrong. Replace with safe steps. Fix ~50 wiki links that pointed at a local .wiki path. - ROADMAP/CLAUDE.md: match the v2.0.2, v3.0.0 and v3.1.0 milestones. Document error.rs, magic_sets.rs, fault_inject.rs and src/browser/. - README: state MSRV 1.89, show the #371 known issue, fix Maven coordinates (io.github.project-minigraf), Android on Maven Central, and point binding downloads to the binding repos. - SECURITY.md: 2.x is the supported line. Refs #383, #397, #399 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BBxgR4mnF8VMVGa42idcxx
…-lbxulz # Conflicts: # ROADMAP.md
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
This PR fixes doc problems found in a full docs and wiki review (see #383).
docs/ERROR_REFERENCE.mdWAL-001, WAL-002 and STG-011 told users one of two things:.walfile with no data loss ("committed facts are in the.graphfile"), orBoth are wrong. Transactions committed since the last checkpoint exist only in the WAL, and the WAL holds nothing older than that checkpoint. The new text says to copy both files first, to checkpoint with the version that wrote the WAL, and what is lost if the WAL is deleted.
ERROR_REFERENCE.mdpointed at../../.wiki/..., a local clone path. They now use full wiki URLs, with anchors mapped to the real headings. One../BENCHMARKS.mdlink was also wrong.CLAUDE.md now documents
error.rs,magic_sets.rs,fault_inject.rsandsrc/browser/.io.github.project-minigraf(checked on Maven Central, 2.0.1 is published there; nothing is underio.github.adityamukho);.wasm, C or Swift assets).The PHILOSOPHY.md stability wording is left for #397, because it needs a policy decision. Wiki fixes are pushed separately to the wiki repo.
Type of change
Checklist
cargo testpasses (--lib error_referenceand--lib registry, which parseERROR_REFERENCE.md, were rerun; the full suite passed at 69da4b2 with 1,168 passed and 8 ignored)CHANGELOG.mdupdated underUnreleasedNotes for reviewer
Please check the new WAL-002 steps ("open with the version that wrote the WAL and call
checkpoint()") against how you want downgrades handled.🤖 Generated with Claude Code
https://claude.ai/code/session_01BBxgR4mnF8VMVGa42idcxx
Generated by Claude Code