Skip to content

fix(docs): add the 6 missing published docs pages to the DocsNav sidebar#8501

Closed
kai392 wants to merge 1 commit into
JSONbored:mainfrom
kai392:fix/critical-issue-docsnav-sidebar-pages
Closed

fix(docs): add the 6 missing published docs pages to the DocsNav sidebar#8501
kai392 wants to merge 1 commit into
JSONbored:mainfrom
kai392:fix/critical-issue-docsnav-sidebar-pages

Conversation

@kai392

@kai392 kai392 commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Fixes #8385

Resubmission of #8476 with the required per-viewport UI evidence filled in. The code is unchanged from that review (which reported no blockers / readiness 93/100); only the evidence table was missing.

Summary

docsNav (apps/loopover-ui/src/components/site/docs-nav.tsx) is hand-maintained alongside docs.index.tsx's separate landing grid. Six published pages had real content/docs/*.mdx content and index links but no sidebar entry: miner-quickstart, loopover-commands, ai-summaries, owner-checklist, self-hosting-docs-audit, self-hosting-unified-ams-orb.

DocsPrevNext builds its footer links from the same array via groupItems(), so those pages were unreachable from the left rail and skipped in the prev/next reading flow.

UI Evidence

Captured on /docs/miner-quickstart (one of the six) at fixed viewports, dark theme — the build is dark-mode-only. Before shows the sidebar with no entry for the page being viewed and nothing highlighted; after shows it listed and active.

Viewport · Theme Before After
Desktop · Dark (1280×800) Desktop dark, before Desktop dark, after
Tablet · Dark (768×1024) Tablet dark, before Tablet dark, after
Mobile · Dark (375×812) Mobile dark, before Mobile dark, after

Scope

Additive only — no existing entry removed or reordered. Each page placed in the group the issue specifies, reusing docs.index.tsx's established label:

Page Group Label
miner-quickstart Get started Quickstart by lane
loopover-commands Core concepts @Loopover commands
ai-summaries Operating AI summaries policy
self-hosting-unified-ams-orb Maintainers › Self-hosting: integrations Unified ORB + AMS
self-hosting-docs-audit Maintainers › Self-hosting: release & security Self-host docs audit
owner-checklist Maintainers › GitHub App & managed beta Onboarding checklist

self-hosting-docs-audit went to release & security rather than setup because its frontmatter describes a pre-release accuracy checklist, next to the existing "Release checklist". docs.index.tsx is deliberately untouched, per the issue.

Drift guard

New docs-nav.test.tsx, co-located per convention, reading real files as docs-source-server-isolation.test.ts already does. content/docs/ is the source of truth:

  • every .mdx has a sidebar entry (the regression)
  • no entry points at an unpublished page
  • no page listed twice, so prev/next can't revisit one
  • the directory read is asserted non-empty, so the others can't pass vacuously

It genuinely fails pre-fix: stashing only the docs-nav.tsx change reports exactly the 6 missing slugs; restoring it passes 4/4.

Validation

  • npm --workspace @loopover/ui run test -- src/components/site/docs-nav.test.tsx — 4/4, re-run after rebasing onto current main (962fa085), since the guard asserts against the live content/docs/ directory
  • npm --workspace @loopover/ui run typecheck — clean; prettier --check clean on both files
  • apps/** is outside Codecov's coverage.include, so no patch percentage applies; the drift guard is the deliverable preventing recurrence

@kai392
kai392 requested a review from JSONbored as a code owner July 24, 2026 15:51
@superagent-security

Copy link
Copy Markdown
Contributor

Superagent didn't find any vulnerabilities or security issues in this PR.

miner-quickstart, loopover-commands, ai-summaries, owner-checklist,
self-hosting-docs-audit, and self-hosting-unified-ams-orb all have published,
cross-linked content/docs/*.mdx pages but no docsNav entry, so they were
unreachable from the persistent sidebar and skipped by DocsPrevNext.

Adds a drift guard so a future page that forgets its entry fails a test.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@kai392

kai392 commented Jul 24, 2026

Copy link
Copy Markdown
Contributor Author

Closing and re-filing from a branch rebased onto current main. The changes job's whitespace step compares against the PR's recorded base SHA, which had advanced past my branch point — so the diff included the reverse of other merged commits, and git diff --check flagged CRLF line endings in src/review/inline-comment-range.ts, a file this PR never touches. Rebasing removes those unrelated files from the diff entirely. Re-filing rather than force-pushing, since a push to an open PR trips the auto-close gate.

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.

DocsNav sidebar is missing 6 published, cross-linked docs pages

2 participants