fix(docs): add the 6 missing published docs pages to the DocsNav sidebar#8501
Closed
kai392 wants to merge 1 commit into
Closed
fix(docs): add the 6 missing published docs pages to the DocsNav sidebar#8501kai392 wants to merge 1 commit into
kai392 wants to merge 1 commit into
Conversation
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>
Contributor
Author
|
Closing and re-filing from a branch rebased onto current main. The |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 alongsidedocs.index.tsx's separate landing grid. Six published pages had realcontent/docs/*.mdxcontent and index links but no sidebar entry:miner-quickstart,loopover-commands,ai-summaries,owner-checklist,self-hosting-docs-audit,self-hosting-unified-ams-orb.DocsPrevNextbuilds its footer links from the same array viagroupItems(), 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.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:miner-quickstartloopover-commandsai-summariesself-hosting-unified-ams-orbself-hosting-docs-auditowner-checklistself-hosting-docs-auditwent to release & security rather than setup because its frontmatter describes a pre-release accuracy checklist, next to the existing "Release checklist".docs.index.tsxis deliberately untouched, per the issue.Drift guard
New
docs-nav.test.tsx, co-located per convention, reading real files asdocs-source-server-isolation.test.tsalready does.content/docs/is the source of truth:.mdxhas a sidebar entry (the regression)It genuinely fails pre-fix: stashing only the
docs-nav.tsxchange 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 currentmain(962fa085), since the guard asserts against the livecontent/docs/directorynpm --workspace @loopover/ui run typecheck— clean;prettier --checkclean on both filesapps/**is outside Codecov'scoverage.include, so no patch percentage applies; the drift guard is the deliverable preventing recurrence