Repository navigation
Closed
Labels
closed-outVerified and closed outVerified and closed outdocumentationImprovements or additions to documentationImprovements or additions to documentation
Description
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 Guides and Reference nav group (16 pages) against current main (v0.88 or later).
Pages
-
guides/legacy-codebases.mdx -
guides/skill-pack-authoring.mdx -
guides/stitch-integration.mdx -
guides/docker-setup.mdx -
reference/architecture.mdx -
reference/god-view.mdx(also edited by docs: fix published pages that contradict the product (state branch, Cloister routing, Inspect, phone apps, introduction) #5472: audit it after that PR merges, on top of its result) -
reference/agents-directory.mdx -
reference/workers.mdx -
reference/lanes.mdx -
reference/state-model.mdx -
reference/harness-landscape.mdx -
reference/posthog-agents.mdx -
reference/template-conversations.mdx(also edited by docs: P3 batch (operating guide, foreman, CI integrations, unpublished pages, proposal in nav, blog draft, small gaps) #5482: audit it after that PR merges, on top of its result) -
reference/prompts.mdx -
reference/troubleshooting.mdx -
reference/token-spend-report.mdx
For each page
- 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.
- Verify each claim against current code (
git grep),pan <verb> --help,src/lib/config-yaml/defaults.ts, the dashboard source, andchangelog.mdx. Do not trust other docs pages as proof; several are stale. - 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.
- Frontmatter: specific searchable
title,description50 to 160 characters, no em or en dashes in either. Remove em dashes from the body too. - Check every link on the page resolves.
- 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 validateor 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.
Metadata
Metadata
Assignees
Labels
closed-outVerified and closed outVerified and closed outdocumentationImprovements or additions to documentationImprovements or additions to documentation
Activity
docs: validate the Features group and draft the PR body (PAN-5502)
docs: restore PR body headings for the Features audit (PAN-5502)
docs: validate the Features group and draft the PR body (PAN-5502)
docs: restore PR body headings for the Features audit (PAN-5502)
PAN-5502 (#5583)
eltmon commentedon Nov 19, 2026
🤖 Agent completed work:
Anomalies: discarded an uncommitted planner note in .overdeck/context/codebase/concerns.md (NFR-1; text kept for the PR body). Skipped harness-landscape rows 8 and 20 (D10) and docker-setup row 22 (D9, V2 applied). Residual fixes beyond the tables in prompts, harness-landscape (omp needs Bun) and architecture (unused ThemedImage import removed). mint validate keeps 16 duplicate-h1 warnings (5 in scope) because NFR-2 bars heading changes. Delivered: accuracy audit of all 18 Guides/Reference pages, dash-free, frontmatter and links fixed; lint:docs, both named vitest files, mint validate and broken-links --check-anchors pass.
eltmon commentedon Nov 19, 2026
Closed via close-out ceremony
Definition of Done
Gate: passed