Skip to content

Minor: Standardise CLI reference doc Synopsis and Aside conventions#3364

Merged
sacOO7 merged 1 commit intomainfrom
fix/cli-doc-options
May 5, 2026
Merged

Minor: Standardise CLI reference doc Synopsis and Aside conventions#3364
sacOO7 merged 1 commit intomainfrom
fix/cli-doc-options

Conversation

@sacOO7
Copy link
Copy Markdown
Contributor

@sacOO7 sacOO7 commented May 4, 2026

  • Append missing [options] to 13 ## Synopsis blocks in src/pages/docs/cli/ so every command page that
    documents options has a synopsis terminating with the [options] placeholder.
  • Standardise the <Aside data-type=…> JSX attribute to single quotes across 7 files, aligning with the
    convention example in CLAUDE.md.
  • Add a one-line note to CLAUDE.md that CLI reference docs deliberately use kebab-case for argument and
    flag placeholders (vs. the upstream oclif SNAKE_CASE), so future contributors don't "fix" the casing.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 4, 2026

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 6114a371-1e04-4b48-9d7d-5de2af89c74c

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/cli-doc-options

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

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 ## Synopsis command lines for CLI pages that document options.
  • Standardizes <Aside data-type=...> to use single quotes in updated CLI docs.
  • Updates the ably env page’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.

Comment thread src/pages/docs/cli/env.mdx
@sacOO7 sacOO7 force-pushed the fix/cli-doc-options branch from ea950b2 to fa9417f Compare May 4, 2026 06:52
@sacOO7 sacOO7 marked this pull request as ready for review May 4, 2026 07:11
@sacOO7 sacOO7 requested review from AndyTWF and m-hulbert May 4, 2026 07:11
@sacOO7 sacOO7 changed the title Standardise CLI reference doc Synopsis and Aside conventions Minor: Standardise CLI reference doc Synopsis and Aside conventions May 5, 2026
@sacOO7 sacOO7 merged commit 28e756e into main May 5, 2026
7 checks passed
@sacOO7 sacOO7 deleted the fix/cli-doc-options branch May 5, 2026 11:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants