Skip to content

docs: give every hierarchical command a subcommand table in the CLI reference - #11766

Open
AvilaJulio wants to merge 1 commit into
cube-js:masterfrom
AvilaJulio:docs/cli-command-table
Open

docs: give every hierarchical command a subcommand table in the CLI reference#11766
AvilaJulio wants to merge 1 commit into
cube-js:masterfrom
AvilaJulio:docs/cli-command-table

Conversation

@AvilaJulio

@AvilaJulio AvilaJulio commented Sep 4, 2026

Copy link
Copy Markdown
Member

The command table lists one row per top-level command, with each command's
subcommands packed into its Description cell — where they were listed at all.
A reader scanning the Command column for a command they had not seen
before cannot find enable-branch in it. That is exactly what happened to a
Cube SE helping a customer set up branch-per-PR CI: the command has been in
the data-model cell since #11433 and the page has been live since #11333,
but neither was reachable by scanning.

Expanding the rows in place would flatten each command into several apparent
top-level commands and lose the hierarchy the table exists to show. So this
keeps the table as a flat index and adds subcommand tables below it, grouped
by domain — authentication, deployment, GitHub, data model, dbt, workspace
content, users and access control, administration, embedding, agents/app.
Each hierarchical row links to its group, and the narrative sections
(Data model Git workflow, dbt sync) link into the same tables rather than
repeating them.

Every subcommand comes from cube <command> --help on CLI 1.7.33, checked
programmatically against all 23 hierarchical commands, so the tables match
what the binary reports. That surfaced a fair amount the page did not mention
at all — the third-level trees (notifications recipients,
integrations tokens, embed tenant, attributes values,
scim users/groups), plus exit-dev-mode and file-hashes, both used by
the Git workflow section but missing or unexplained.

The enable-branch paragraph gets its own ### heading so the tables have an
anchor to link to, and so it earns a TOC entry.

Verified against a local mintlify dev render: all 14 cross-references
resolve to real heading ids, no link reference renders literally, and the
top-level table is unchanged in shape.

🤖 Generated with Claude Code

@AvilaJulio
AvilaJulio requested a review from keydunov as a code owner September 4, 2026 14:39
@AvilaJulio
AvilaJulio force-pushed the docs/cli-command-table branch from 1947dfd to eccb0a1 Compare September 4, 2026 14:46
@AvilaJulio AvilaJulio changed the title docs: make data-model subcommands scannable in the CLI command table docs: give data-model subcommands their own table in the CLI reference Sep 4, 2026
…eference

The command table lists one row per top-level command, with each command's
subcommands packed into its Description cell — where they were listed at
all. A reader scanning the Command column for a command they had not seen
before cannot find `enable-branch` there, even though it was added to the
`data-model` cell in cube-js#11433.

Keep that table as a flat index of top-level commands, and add subcommand
tables below it grouped by domain: authentication, deployment, GitHub,
data model, dbt, workspace content, users and access control,
administration, embedding, and agents/app. Each hierarchical row in the
index links to its group, and the narrative sections link into the same
tables rather than repeating them.

Every subcommand is taken from `cube <command> --help` (CLI 1.7.33), so
the tables match what the binary reports, including third-level ones
(`notifications recipients`, `integrations tokens`, `embed tenant`,
`attributes values`, `scim users`/`groups`) that the page did not mention
at all. This also restores `exit-dev-mode` and `file-hashes`, both used by
the Git workflow section but missing or unexplained before.

The `enable-branch` prose gets its own heading so the tables have an
anchor to link to.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@AvilaJulio
AvilaJulio force-pushed the docs/cli-command-table branch from eccb0a1 to f00d0e7 Compare September 4, 2026 14:54
@AvilaJulio AvilaJulio changed the title docs: give data-model subcommands their own table in the CLI reference docs: give every hierarchical command a subcommand table in the CLI reference Sep 4, 2026
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.

3 participants