Minor: Standardise CLI reference doc Synopsis and Aside conventions#3364
Minor: Standardise CLI reference doc Synopsis and Aside conventions#3364
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ 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.
Pull request overview
Standardizes formatting conventions across the CLI reference MDX pages to improve consistency (synopsis format and <Aside> attribute quoting), aligning with documented MDX conventions.
Changes:
- Appends
[options]to## Synopsiscommand lines for CLI pages that document options. - Standardizes
<Aside data-type=...>to use single quotes in updated CLI docs. - Updates the
ably envpage’s<Aside>quoting (and keeps synopsis consistent with the CLI docs style).
Reviewed changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/pages/docs/cli/version.mdx | Adds [options] to the synopsis for consistency with documented options. |
| src/pages/docs/cli/spaces/occupancy/get.mdx | Adds [options] to the synopsis. |
| src/pages/docs/cli/spaces/members/get.mdx | Adds [options] to the synopsis. |
| src/pages/docs/cli/spaces/locks/get.mdx | Adds [options] to the synopsis (after optional lock-id). |
| src/pages/docs/cli/spaces/locations/get.mdx | Adds [options] to the synopsis. |
| src/pages/docs/cli/spaces/get.mdx | Adds [options] to the synopsis. |
| src/pages/docs/cli/spaces/cursors/get.mdx | Adds [options] to the synopsis. |
| src/pages/docs/cli/push/devices/get.mdx | Adds [options] to the synopsis. |
| src/pages/docs/cli/config/show.mdx | Adds [options] to the synopsis. |
| src/pages/docs/cli/config/path.mdx | Adds [options] to the synopsis. |
| src/pages/docs/cli/autocomplete.mdx | Adds [options] to the synopsis. |
| src/pages/docs/cli/interactive.mdx | Adds [options] to the synopsis; switches <Aside> data-type quotes to single quotes. |
| src/pages/docs/cli/apps/current.mdx | Adds [options] to the synopsis. |
| src/pages/docs/cli/login.mdx | Switches <Aside> data-type quotes to single quotes. |
| src/pages/docs/cli/env.mdx | Switches <Aside> data-type quotes to single quotes. |
| src/pages/docs/cli/auth/revoke-token.mdx | Switches <Aside> data-type quotes to single quotes. |
| src/pages/docs/cli/apps/update.mdx | Switches <Aside> data-type quotes to single quotes. |
| src/pages/docs/cli/apps/rules/update.mdx | Switches <Aside> data-type quotes to single quotes. |
| src/pages/docs/cli/apps/delete.mdx | Switches <Aside> data-type quotes to single quotes. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
ea950b2 to
fa9417f
Compare
[options]to 13## Synopsisblocks insrc/pages/docs/cli/so every command page thatdocuments options has a synopsis terminating with the
[options]placeholder.<Aside data-type=…>JSX attribute to single quotes across 7 files, aligning with theconvention example in
CLAUDE.md.CLAUDE.mdthat CLI reference docs deliberately use kebab-case for argument andflag placeholders (vs. the upstream oclif
SNAKE_CASE), so future contributors don't "fix" the casing.