docs: link backup & recovery docs#354
Open
paolodamico wants to merge 1 commit into
Open
Conversation
aurel-fr
approved these changes
May 20, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Updates Bedrock’s backup module documentation to point readers to centralized “Backup & Recovery” docs and reduce redundant crate-root docs.
Changes:
- Add module-level docs and central documentation link in
backup/mod.rs. - Add a pointer to centralized “service rejects” error documentation for
BackupError. - Remove redundant
backupmodule docs fromlib.rs.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
bedrock/src/lib.rs |
Removes redundant crate-root backup module docs. |
bedrock/src/backup/mod.rs |
Adds module-level docs and links to centralized Backup & Recovery documentation and error details. |
|
|
||
| /// Adds new factor by re-encrypting the backup keypair (not the backup itself!) | ||
| /// with a new factor secret. | ||
| /// with a new factor secret. (See BF-3 Adding a Main Faactor) |
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.
Note
Low Risk
Doc-only changes (module and error documentation) with no functional or behavioral impact.
Overview
Adds central Backup & Recovery documentation links and clearer module-level docs in
backup/mod.rs, including references for architecture/threat model and service rejection reasons.Removes redundant crate-root
backupmodule doc comments fromlib.rsand tweaks a factor-management docstring for clarity.Reviewed by Cursor Bugbot for commit ee98c42. Bugbot is set up for automated code reviews on this repo. Configure here.