Skip to content

docs: add ACE recovery guide for catastrophic node failures.#341

Open
ibrarahmad wants to merge 4 commits intopgEdge:mainfrom
ibrarahmad:DOC-NODE-Failure
Open

docs: add ACE recovery guide for catastrophic node failures.#341
ibrarahmad wants to merge 4 commits intopgEdge:mainfrom
ibrarahmad:DOC-NODE-Failure

Conversation

@ibrarahmad
Copy link
Contributor

Add a new Spock documentation page describing how to recover a lagging node after catastrophic failure using ACE table-diff/table-repair, including single-node and multiple-node failure scenarios and per-origin recovery.

Document multi-table diff/repair workflows and require --preserve-origin to preserve origin ID and commit timestamp; add MkDocs navigation entry and cross-links from modify/index.md and FAQ.md.

Add a new Spock documentation page describing how to recover a lagging node
after catastrophic failure using ACE table-diff/table-repair, including
single-node and multiple-node failure scenarios and per-origin recovery.

Document multi-table diff/repair workflows and require --preserve-origin to
preserve origin ID and commit timestamp; add MkDocs navigation entry and
cross-links from modify/index.md and FAQ.md.
@coderabbitai
Copy link

coderabbitai bot commented Feb 11, 2026

📝 Walkthrough

Walkthrough

Adds documentation on node failure recovery: a new FAQ subsection, updates to node-adding docs introducing Spockctrl and recovery notes, and a detailed catastrophic node failure recovery guide describing ACE workflows, commands, and troubleshooting (single- and multi-node scenarios).

Changes

Cohort / File(s) Summary
FAQ & Node-adding docs
docs/FAQ.md, docs/modify/index.md
Adds a “Node failure and recovery” FAQ subsection and three bullet points to node-adding docs introducing Spockctrl, production usage guidance, and ACE-based resync recovery instructions.
Catastrophic recovery guide
docs/recovery/catastrophic_node_failure.md
New comprehensive guide (five-phase workflow) covering single- and multi-node recovery with ACE commands (table-diff, table-repair), examples, --preserve-origin usage, diagrams, step-by-step commands, caveats, and troubleshooting.

Poem

🐇 I nudge the logs where timestamps play,
I hop through diffs to stitch the fray.
With carrots of commands and a thump so steady,
ACE mends the gaps and keeps the data ready. 🌱✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The pull request title clearly and accurately summarizes the main change: adding ACE recovery documentation for catastrophic node failures.
Description check ✅ Passed The description is directly related to the changeset, providing details about the new recovery guide, covered scenarios, required options, and documentation links.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

No actionable comments were generated in the recent review. 🎉

🧹 Recent nitpick comments
docs/recovery/catastrophic_node_failure.md (2)

3-8: Tighten phrasing (“all of the” → “all the”)
Optional style polish to reduce wordiness.

📝 Proposed tweak
- because of network delay, n2 has not yet received all of the transactions
+ because of network delay, n2 has not yet received all the transactions

629-633: Avoid “very” for a cleaner tone
Optional wording tweak to keep the prose crisp.

📝 Proposed tweak
- For very large tables, ACE supports options such as `--table-filter` to
+ For large tables, ACE supports options such as `--table-filter` to

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Updated the documentation for recovering from catastrophic node failure - wrapped at 79 characters, and now starting to edit...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants