Skip to content

docs: gen_docs emits pages for Hidden commands (deprecated delegates, experimental-gated, internal entrypoints)Β #6063

Description

@devantler

πŸ€– Generated by the Daily AI Engineer

Problem

docs/gen_docs.go walks c.Commands() without checking Hidden, so the generated docs/src/content/docs/cli-flags/ tree ships pages for commands that are deliberately kept out of --help and the MCP/toolgen surface: deprecated flat delegates (project add-environment, project list-environments, cluster add-environment), experimental-gated commands, and internal entrypoints (steer-agent). Docs advertising names we are actively retiring (or that refuse to run without --experimental) undercuts the deprecation/gating story. Observed repeatedly (632nd-run note; flagged again by review on #6059).

Proposed direction

Skip Hidden commands in gen_docs by default β€” or, if some hidden pages are wanted (e.g. experimental commands documented as opt-in), add an explicit allowlist/annotation so each hidden page is a deliberate choice rather than a fallthrough. Regenerate and prune orphaned pages in the same PR; verify Starlight's autogenerated sidebar/index no longer lists retired names.

Rough size

S β€” one condition in the walker + an annotation if the allowlist route is chosen, plus a regen and snapshot pass.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    Status
    πŸƒπŸ»β€β™‚οΈ In Progress

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions