diff --git a/CLAUDE.md b/CLAUDE.md index 2f19893ccc..c955af1967 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -297,6 +297,10 @@ See `writing-style-guide.md` for full details. Key points: - Avoid em-dashes, Latin abbreviations (use "for example" not "e.g."), and slang - Avoid bold prefixes in bullet points +## CLI reference docs (`src/pages/docs/cli/`) + +CLI command pages use **kebab-case** for argument and flag placeholders (for example ``, `[lock-id]`, `--client-id`), even when the upstream oclif autogenerated reference uses `SNAKE_CASE`/uppercase (for example `CHANNEL_NAME`). This case difference is the deliberate doc convention — do not "fix" pages to match oclif casing. + ## Testing Tests use Jest with React Testing Library. Test files are colocated with source files as `*.test.tsx` or `*.test.ts`. diff --git a/src/pages/docs/cli/apps/current.mdx b/src/pages/docs/cli/apps/current.mdx index 2501816cad..490b6bf476 100644 --- a/src/pages/docs/cli/apps/current.mdx +++ b/src/pages/docs/cli/apps/current.mdx @@ -10,7 +10,7 @@ Use the `ably apps current` command to display information about the currently s ```shell -ably apps current +ably apps current [options] ``` diff --git a/src/pages/docs/cli/apps/delete.mdx b/src/pages/docs/cli/apps/delete.mdx index 15db935a4a..88609dcd66 100644 --- a/src/pages/docs/cli/apps/delete.mdx +++ b/src/pages/docs/cli/apps/delete.mdx @@ -14,7 +14,7 @@ ably apps delete [app-id] [options] ``` -