Skip to content

docs: Add 'minimal' scope to backup command documentation#17

Merged
KHAEntertainment merged 3 commits intomasterfrom
fix/issue-10-minimal-scope-docs
Mar 26, 2026
Merged

docs: Add 'minimal' scope to backup command documentation#17
KHAEntertainment merged 3 commits intomasterfrom
fix/issue-10-minimal-scope-docs

Conversation

@KHAEntertainment
Copy link
Copy Markdown
Owner

@KHAEntertainment KHAEntertainment commented Mar 22, 2026

Summary

Adds the missing minimal scope option to SKILL.md documentation for the /ocbs backup command:

  • 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

Changes

  • SKILL.md: Updated scope parameter lists and added scope behavior table

Test plan

  • Verify minimal scope appears in /ocbs backup --help
  • Verify minimal scope appears in /ocbs native-backup --help
  • Confirm scope table is rendered correctly in documentation

Fixes #10

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation

    • Added a new "minimal" scope option for backup and native-backup commands to create smallest-footprint backups containing essential metadata only.
    • Replaced the previous scope notes with a clear "Scope behavior" table defining what each scope includes.
  • Chores

    • Normalized packaging metadata for an optional dependency specification format.

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>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 22, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 0f7faa50-df74-46b1-8d8e-cb3a8334dae3

📥 Commits

Reviewing files that changed from the base of the PR and between 961d949 and 71bbbb4.

📒 Files selected for processing (1)
  • pyproject.toml

Walkthrough

Adds a new minimal backup scope to SKILL.md and updates the clawhub optional dependency in pyproject.toml from a string to an array. Both are documentation/metadata edits with no behavioral code changes.

Changes

Cohort / File(s) Summary
Scope documentation
SKILL.md
Added minimal to the /ocbs backup --scope parameter and replaced the prior bullet notes with a "Scope behavior" table describing config, config+session, config+session+workspace, and minimal (metadata-only). File ends without a trailing newline.
Project metadata
pyproject.toml
Changed optional dependency syntax for clawhub from a single string ("clawhub>=0.1.0") to an array (["clawhub>=0.1.0"]).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

A little scope named "minimal" arrives,
Docs reshuffled, small tweaks to the archives.
A bracketed dependency finds its place,
Quiet edits—neat lines, gentle grace. ✨

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 warnings)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The PR includes an undocumented change to pyproject.toml's clawhub dependency format that is not addressed in issue #10 and appears unrelated to documentation updates. Remove the pyproject.toml changes or document why the clawhub dependency format change is necessary for this PR's objectives.
Out of Scope Changes check ⚠️ Warning The modification to pyproject.toml changing clawhub from a string to an array format is out of scope for a documentation-only PR about minimal scope. Revert the pyproject.toml changes unless they are essential to implementing the minimal scope feature and documented in the issue.
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and concisely describes the main change: adding 'minimal' scope documentation to the backup command.
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
  • Commit unit tests in branch fix/issue-10-minimal-scope-docs

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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: df2a22db-c504-413b-81e3-decd398c49cd

📥 Commits

Reviewing files that changed from the base of the PR and between 34626a9 and 47d007b.

📒 Files selected for processing (1)
  • SKILL.md

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 26, 2026

Note

Autofix is a beta feature. Expect some limitations and changes as we gather feedback and continue to improve it.

Fixes Applied Successfully

Fixed 2 file(s) based on 2 unresolved review comments.

Files modified:

  • SKILL.md
  • pyproject.toml

Commit: 961d949ea1ec2afe559d1a8398195eede44c2b25

The changes have been pushed to the fix/issue-10-minimal-scope-docs branch.

Time taken: 5m 32s

Fixed 2 file(s) based on 2 unresolved review comments.

Co-authored-by: CodeRabbit <noreply@coderabbit.ai>
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 47d007b and 961d949.

📒 Files selected for processing (2)
  • SKILL.md
  • pyproject.toml
✅ Files skipped from review due to trivial changes (1)
  • SKILL.md

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 26, 2026

Note

Autofix is a beta feature. Expect some limitations and changes as we gather feedback and continue to improve it.

⚠️ Branch updated during autofix.

The branch was updated while autofix was in progress. Please try again.

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@KHAEntertainment KHAEntertainment merged commit 5b0b758 into master Mar 26, 2026
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.

docs: Add 'minimal' scope to backup command documentation

1 participant