docs: document missing skill registry subcommand and fix Starlight sidebar config - #530
Conversation
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
📝 WalkthroughSummary by CodeRabbit
WalkthroughThe documentation now describes ChangesDocumentation updates
Estimated code review effort: 2 (Simple) | ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 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 |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@website/docs/src/content/docs/reference/cli.mdx`:
- Line 292: Update the documentation text “maintainer curated registry” to
“maintainer-curated registry” in the registry validation statement.
- Around line 300-308: Update the validate command documentation to describe
manifest-only validation, matching the runtime behavior of load_curated_registry
in the validate flow. Remove the --lock option and its default path from the
documented options, unless the implementation is first changed to load and
compare the lockfile.
🪄 Autofix
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: ASSERTIVE
Plan: Pro Plus
Run ID: 9357eeae-3983-4cc6-8272-0f988671a045
📒 Files selected for processing (3)
.agents/journal/scribe-journal.mdwebsite/docs/astro.config.mjswebsite/docs/src/content/docs/reference/cli.mdx
|
|
||
| #### `registry` | ||
|
|
||
| Validate and refresh the maintainer curated registry. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Hyphenate the compound modifier.
Change maintainer curated registry to maintainer-curated registry.
LanguageTool flagged this line.
🧰 Tools
🪛 LanguageTool
[grammar] ~292-~292: Use a hyphen to join words.
Context: ...ry` Validate and refresh the maintainer curated registry. ```bash agentsync ski...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@website/docs/src/content/docs/reference/cli.mdx` at line 292, Update the
documentation text “maintainer curated registry” to “maintainer-curated
registry” in the registry validation statement.
Source: Linters/SAST tools
| Validate a curated registry manifest against its lockfile constraints. | ||
|
|
||
| ```bash | ||
| agentsync skill registry validate [OPTIONS] | ||
| ``` | ||
|
|
||
| **Options**: | ||
| - `--manifest <MANIFEST>`: Path to the registry manifest file (defaults to `src/skills/registry.v1.toml`). | ||
| - `--lock <LOCK>`: Path to the registry lockfile (defaults to `src/skills/registry.lock.toml`). |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win
Do not document validate as a lockfile check.
The runtime passes only args.manifest to load_curated_registry. The --lock path is not read or compared. This makes both the description and the --lock option misleading.
Document validate as manifest-only and remove --lock, unless the CLI implementation is changed to validate the lockfile.
Proposed documentation fix
-Validate a curated registry manifest against its lockfile constraints.
+Validate a curated registry manifest.
...
- - `--lock <LOCK>`: Path to the registry lockfile (defaults to `src/skills/registry.lock.toml`).This assessment uses the supplied runtime snippets in src/commands/skill.rs, Lines [790-805], and src/skills/registry.rs, Lines [69-78].
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Validate a curated registry manifest against its lockfile constraints. | |
| ```bash | |
| agentsync skill registry validate [OPTIONS] | |
| ``` | |
| **Options**: | |
| - `--manifest <MANIFEST>`: Path to the registry manifest file (defaults to `src/skills/registry.v1.toml`). | |
| - `--lock <LOCK>`: Path to the registry lockfile (defaults to `src/skills/registry.lock.toml`). | |
| Validate a curated registry manifest. | |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@website/docs/src/content/docs/reference/cli.mdx` around lines 300 - 308,
Update the validate command documentation to describe manifest-only validation,
matching the runtime behavior of load_curated_registry in the validate flow.
Remove the --lock option and its default path from the documented options,
unless the implementation is first changed to load and compare the lockfile.
|
2 participants
Documented the missing
agentsync skill registrysubcommand and its nestedvalidateandsynccommands on the CLI Reference page. Also corrected an obsolete sidebar autogenerate configuration inastro.config.mjsto resolve documentation site build failures.PR created automatically by Jules for task 6681027526467473080 started by @yacosta738