docs: Add 'minimal' scope to backup command documentation#17
docs: Add 'minimal' scope to backup command documentation#17KHAEntertainment merged 3 commits intomasterfrom
Conversation
Adds the missing 'minimal' scope option to SKILL.md: - Added 'minimal' to backup command scope parameter - Added 'minimal' to native-backup command scope parameter - Added scope behavior table with all four scopes and descriptions - Included minimal scope description explaining its use for checkpoint markers without duplicating data Closes #10 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughAdds a new Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@SKILL.md`:
- Around line 27-35: Update the documentation for the `minimal` scope in the
SKILL.md table to explicitly state that `minimal` stores only backup metadata
(backup ID, timestamp, scope, reason) in the SQLite database and does not store
any file contents; clarify that this mode is intended as a checkpoint marker
rather than a full payload backup so operators can distinguish it from
`config`/`config+session`/`config+session+workspace`.
- Line 23: Docs list a `minimal` scope for the native-backup command but the
native-backup scope conversion does not handle `MINIMAL`; update the
native-backup scope conversion logic to explicitly handle the
`minimal`/`MINIMAL` token (in the native-backup command handler or scope-parsing
function) and map it to the same payload/behavior used by the other backup
implementation (or, if you prefer not to implement, remove `minimal` from the
native-backup documentation entries instead) so the docs and implementation
match.
🪄 Autofix (Beta)
✅ Autofix completed
|
Note Autofix is a beta feature. Expect some limitations and changes as we gather feedback and continue to improve it. Fixes Applied SuccessfullyFixed 2 file(s) based on 2 unresolved review comments. Files modified:
Commit: The changes have been pushed to the Time taken: |
Fixed 2 file(s) based on 2 unresolved review comments. Co-authored-by: CodeRabbit <noreply@coderabbit.ai>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@pyproject.toml`:
- Line 35: Add a trailing newline to the end of pyproject.toml so the final line
containing python_files = ["test_*.py"] is terminated by a newline character;
simply ensure the file ends with a single '\n' after that line.
🪄 Autofix (Beta)
❌ Autofix failed (check again to retry)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 8e61948f-bda9-4dd9-97b7-ea7020a9a549
📒 Files selected for processing (2)
SKILL.mdpyproject.toml
✅ Files skipped from review due to trivial changes (1)
- SKILL.md
|
Note Autofix is a beta feature. Expect some limitations and changes as we gather feedback and continue to improve it. The branch was updated while autofix was in progress. Please try again. |
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Summary
Adds the missing
minimalscope option to SKILL.md documentation for the/ocbs backupcommand:minimalto backup command scope parameterminimalto native-backup command scope parameterChanges
Test plan
minimalscope appears in/ocbs backup --helpminimalscope appears in/ocbs native-backup --helpFixes #10
🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation
Chores