Skip to content

docs: update CLI and configuration reference documentation - #587

Open
yacosta738 wants to merge 1 commit into
mainfrom
docs/plugin-and-compatibility-matrix-fixes-11646960576976225525
Open

docs: update CLI and configuration reference documentation#587
yacosta738 wants to merge 1 commit into
mainfrom
docs/plugin-and-compatibility-matrix-fixes-11646960576976225525

Conversation

@yacosta738

Copy link
Copy Markdown
Contributor

Update AgentSync documentation to accurately reflect CLI subcommands/flags for plugin and fix the Agent Compatibility Matrix table formatting and ordering.


PR created automatically by Jules for task 11646960576976225525 started by @yacosta738

- Add missing `-p, --project-root` global option and `--json` subcommand flags for `agentsync plugin` in `reference/cli.mdx`.
- Alphabetize Agent Compatibility Matrix table in `reference/configuration.mdx` and move inline Cursor note below the table to fix table structure.
@google-labs-jules

Copy link
Copy Markdown
Contributor

👋 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 @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@coderabbitai

coderabbitai Bot commented Sep 5, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Team

Run ID: c3375b0d-374d-4072-bda7-503bfe615044

📥 Commits

Reviewing files that changed from the base of the PR and between 7102a4d and 94cccc0.

📒 Files selected for processing (2)
  • website/docs/src/content/docs/reference/cli.mdx
  • website/docs/src/content/docs/reference/configuration.mdx

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Summary

Summary by CodeRabbit

  • New Features

    • Added a --project-root option to the plugin command.
    • Added --json output options to plugin add, update, list, status, and remove commands.
  • Documentation

    • Reordered the Agent Compatibility Matrix alphabetically.
    • Moved the Cursor rules filename note to immediately follow the compatibility table.

Walkthrough

The CLI reference now documents --project-root and --json plugin options. The configuration reference alphabetizes the Agent Compatibility Matrix and moves the Cursor rules filename note below the table.

Changes

Reference documentation

Layer / File(s) Summary
CLI plugin option reference
website/docs/src/content/docs/reference/cli.mdx
Documents the global --project-root option and --json for the add, update, list, status, and remove subcommands.
Agent compatibility matrix ordering
website/docs/src/content/docs/reference/configuration.mdx
Alphabetizes matrix rows and moves the Cursor rules filename note after the table without changing row content.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to 94ccc

This updates plugin option documentation and improves compatibility-matrix ordering without changing runtime behavior. No current merge-readiness risk remains.

Poem

A rabbit reads the flags at night
--json hops into sight
The project root finds its way
Matrix rows line up today
Cursor’s note rests after play

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description check ✅ Passed The description accurately summarizes the CLI documentation updates and the Agent Compatibility Matrix changes.
Title check ✅ Passed The title clearly and concisely identifies the documentation updates for the CLI and configuration reference.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/plugin-and-compatibility-matrix-fixes-11646960576976225525

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.

@linear-code
linear-code Bot marked this pull request as ready for review September 5, 2026 04:26
@codecov

codecov Bot commented Sep 5, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@sonarqubecloud

sonarqubecloud Bot commented Sep 5, 2026

Copy link
Copy Markdown

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.

1 participant