Skip to content

docs: accuracy audit, CLI Reference (7 pages) #5501

Closed

Description

@eltmon

Part of the docs overhaul epic #5467. Operator direction 2026-11-17: "I am pretty sure there are huge gaps in our documentation and lots of stuff that is outdated, I want a thorough cleanup and really get documentation into tip top shape."

The feature inventory checked which features have docs, not whether each page is accurate. This issue is a line-by-line accuracy audit of every published page in the CLI Reference nav group (7 pages) against current main (v0.88 or later).

Pages

  • cli/overview.mdx
  • cli/core-commands.mdx (also edited by docs: CLI reference completeness #5478: audit it after that PR merges, on top of its result)
  • cli/hygiene.mdx
  • cli/agent-commands.mdx
  • cli/workspace-commands.mdx
  • cli/review-commands.mdx
  • cli/skills-commands.mdx

For each page

  1. Read the whole page. List every factual claim: commands and flags, config keys and defaults, UI labels and locations, file paths, behavior, limits, supported harnesses/trackers/platforms, maturity.
  2. Verify each claim against current code (git grep), pan <verb> --help, src/lib/config-yaml/defaults.ts, the dashboard source, and changelog.mdx. Do not trust other docs pages as proof; several are stale.
  3. Fix wrong claims, delete claims about removed features, and add what a user needs that is missing (short; link to the dedicated page instead of duplicating it). Label early, experimental (Settings → Experimental) and testing features as such.
  4. Frontmatter: specific searchable title, description 50 to 160 characters, no em or en dashes in either. Remove em dashes from the body too.
  5. Check every link on the page resolves.
  6. Tick the page above in the PR body with a one-line note of what changed (or "verified, no change").

Every PR for this issue

  • Run the Mintlify validator (npx mint validate or the current equivalent) and the link check (npx mint broken-links) and paste the clean result in the PR body.
  • Zero U+2013/U+2014 in titles and descriptions of the touched pages.
  • Docs-only: no changelog.d entry unless behavior changed.
  • Where a page talks about getting help, link the Overdeck Discord (https://discord.gg/ZpHE2ZTv5P) and GitHub Issues.

Activity

  1. added
    documentationImprovements or additions to documentation
    planningIssue is in planning/discovery phase
    in-progressWork is actively being done
    and removed
    planningIssue is in planning/discovery phase
    in-progressWork is actively being done
    on Nov 17, 2026
  2. eltmon commented on Nov 19, 2026

    @eltmon
    OwnerAuthor

    🤖 Agent completed work:

    Docs-only accuracy audit of all 10 CLI Reference pages vs code at 0.89.1: no deviations from the plan. Fixed wrong/stale/removed claims, added missing flags and sections (--group, waive-test-removal, untroubled, reset-session, bare pan swarm ), removed 5 pre-rebrand screenshots, retitled 7 pages with sidebarTitle. lint:docs, the no-legacy-task-engine test, mint validate and mint broken-links all pass clean. 16 code-level Follow-ups (not fixed, no code touched) listed in the PR body for a future issue.

  3. added
    mergedMerged to main
    verifying-on-mainMerged — awaiting verification on main
    and removed on Nov 19, 2026
  4. eltmon commented on Nov 19, 2026

    @eltmon
    OwnerAuthor

    PAN-5499 (#5580) recaptured these shared doc screenshots in place: images/dashboard/command-deck-hero-{light,dark}.png, images/dashboard/board-{light,dark}.png and images/dashboard/pipeline-{light,dark}.png. If this issue's pages use any of them (e.g. cli/overview.mdx, cli/core-commands.mdx), their alt text may now describe the old UI and need an update.

  5. eltmon commented on Nov 19, 2026

    @eltmon
    OwnerAuthor

    Closed via close-out ceremony

    Definition of Done
    # Row Status Observed
    1 Review passed ✓ pass PR #5573 reviewDecision: APPROVED
    2 Tests passed ✓ pass PR #5573 checks: all 26 check(s) green
    3 Verification green on the branch ✓ pass verification artifact: passed at 2026-11-19T02:30:10.740Z
    4 Merged to main ✓ pass Pull request #5573 merged at 2026-11-19T02:43:37Z; PR #5573 MERGED at 2026-11-19T02:43:37Z
    5 Post-merge lifecycle ran ✓ pass canonical state: verifying_on_main; no running work/planning agents (stored running, not live: planning-pan-5501)
    6 Verified on main ✓ pass required checks concluded successfully on aabeea7: test, lint, build (22), reject-planning-paths
    7 Version strings propagated – skip project declares no version_sync; ship step not applicable
    8 Deployed ✓ pass build commit 62f98b2 contains merge aabeea7
    9 Close-out teardown verified ✓ pass workspace removed; feature branch kept (close_out.delete_feature_branch is off); No tmux sessions or Herdr panes found; No shadow state found; No legacy planning directory found; Stopped Docker containers; No orphaned processes found; No worker worktrees; Removed git worktree; Pruned 4 agent directories (transcripts and state kept); No strike branch strike/pan-5501 found; Pruned 282 checkpoint ref(s) for agent-pan-5501, planning-pan-5501, strike-pan-5501; No specialist registry entries for PAN-5501

    Gate: passed

  6. added
    closed-outVerified and closed out
    and removed
    mergedMerged to main
    verifying-on-mainMerged — awaiting verification on main
    on Nov 19, 2026
  7. added a commit that references this issue on Nov 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    closed-outVerified and closed outdocumentationImprovements or additions to documentation

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions