Skip to content

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

Merged
loopover-orb[bot] merged 1 commit into
JSONbored:mainfrom
kai392:fix/critical-issue-docsnav-nav-entries
Jul 24, 2026
Merged

fix(docs): add the 6 missing published docs pages to the DocsNav sidebar#8508
loopover-orb[bot] merged 1 commit into
JSONbored:mainfrom
kai392:fix/critical-issue-docsnav-nav-entries

Conversation

@kai392

@kai392 kai392 commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Fixes #8385

Re-file of #8501, which failed the changes job's whitespace step for a reason unrelated to its contents: the check runs git diff --check <base.sha> HEAD, and main had advanced past my branch point between syncing and filing. The diff therefore 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 does not touch. This branch is cut from current main (d09fbe22), so the diff is exactly the 2 files below and git diff --check passes clean. Code is unchanged from #8476, which reviewed at no blockers / readiness 93/100.

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 d09fbe22 (the guard asserts against the live content/docs/ directory, so a doc page added upstream would break it)
  • npm --workspace @loopover/ui run typecheck — clean; prettier --check clean on both files
  • git diff --check upstream/main HEAD — clean
  • apps/** is outside Codecov's coverage.include, so no patch percentage applies

@kai392
kai392 requested a review from JSONbored as a code owner July 24, 2026 16:07
@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>
@loopover-orb loopover-orb Bot added the gittensor:bug Gittensor-scored bug fix — scores a 0.05x multiplier. label Jul 24, 2026
@loopover-orb

loopover-orb Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Tip

✅ LoopOver review result - approve/merge recommended

Review updated: 2026-07-24 16:47:46 UTC

2 files · 1 AI reviewer · no blockers · readiness 95/100 · CI green · clean

✅ Suggested Action - Approve/Merge

  • safe to merge

Review summary
This diff adds six previously-orphaned docs pages (miner-quickstart, self-hosting-unified-ams-orb, self-hosting-docs-audit, owner-checklist, loopover-commands, ai-summaries) to the docsNav array, and every one of them is corroborated by an existing link in docs.index.tsx's AUDIENCES list shown in the reference context — the fix is real and targeted. It also adds a regression test that reads content/docs/*.mdx off disk and asserts full docsNav coverage, no dangling links, and no duplicates, which is a legitimate drift guard rather than a fabricated test. The one open question is that the supplied screenshot evidence reports the before/after images look identical despite the PR's visual claim, which I can't resolve from the diff alone since the code changes themselves are unambiguous and correct.

Nits — 3 non-blocking
  • The screenshot evidence attached to this PR reportedly shows no visible before/after difference despite the description's claim — worth asking the contributor to re-capture or confirm the screenshots actually reflect this commit before merging on visual grounds.
  • docs-nav.test.tsx:16 hardcodes `toBeGreaterThan(40)` as a sanity check on content/docs/ size; harmless now but will need bumping as pages are added/removed, consider deriving from a stable lower bound or dropping the arbitrary threshold.
  • Since docs.index.tsx already lists all these routes by hand in a separate array (see AUDIENCES in the reference context), consider a follow-up issue to derive docsNav and the index page's link lists from one shared source so this class of drift can't recur — not blocking here since it's out of this PR's stated scope.

Decision drivers

  • ✅ Code review — No blockers (1 reviewer)
  • ✅ Gate result — Passing (No configured blocker found.)
Context & advisory signals — never blocks the verdict
Signal Result Evidence
Linked issue ✅ Linked #8385
Related work ✅ No active overlap found No same-issue or scoped active PR overlap found.
Change scope ✅ 20/20 Low review scope from cached public metadata (1 linked issue).
Validation posture ✅ 25/25 PR body includes validation/test evidence.
Contributor workload ✅ 10/10 Author activity: 135 registered-repo PR(s), 68 merged, 10 issue(s).
Contributor context ✅ Confirmed Gittensor contributor kai392; Gittensor profile; 135 PR(s), 10 issue(s).
Improvement ✅ Minor risk: clean · value: minor
Linked issue satisfaction

Addressed
The diff adds all 6 missing pages to docsNav under appropriate existing groups/subgroups exactly as the issue specified, leaves the existing 50 entries and docs.index.tsx untouched, and adds a co-located drift-guard vitest test asserting every content/docs/*.mdx has a docsNav entry.

Review context
  • Author: kai392
  • Role context: outside_contributor
  • Public audience mode: oss maintainer
  • Lane context: Repository is configured for direct PR review.
  • Public profile languages: not available
  • Official Gittensor activity: 135 PR(s), 10 issue(s).
  • PR-specific overlap: none found.
Contributor next steps
  • Start here: Triage stale or unlinked PRs.
Signal definitions
  • Related work = same linked issue, overlapping active PRs, or title/path similarity.
  • Change scope = cached public metadata such as size labels, draft state, and review-burden hints.
  • Validation posture = whether the PR provides enough public validation/test evidence for maintainer review.
  • Contributor workload = public contributor activity and cleanup pressure, not a repo-wide quality failure.
  • Contributor context = public GitHub/Gittensor identity context; non-Gittensor status is not a blocker.
🧪 Chat with LoopOver

Ask LoopOver a question about this PR directly in a comment — grounded only in the same cached, public-safe facts shown above, never a new claim.

  • @loopover ask &lt;question&gt; answers contribution-quality Q&A with source citations and freshness.
  • @loopover chat &lt;question&gt; answers in natural prose from cached decision-pack facts via local inference (maintainer/collaborator; read-only).
  • A plain-language @loopover mention with a real question is routed to the closest matching read-only command automatically — no exact syntax required.

Full command reference: https://loopover.ai/docs/loopover-commands

🧪 Experimental — new and may change.

Visual preview
Route Viewport Before (production) After (this PR's preview) Diff
/ desktop before /
before /
after /
after /
/ mobile before / (mobile)
before / (mobile)
after / (mobile)
after / (mobile)

Click any thumbnail to open the full-size screenshot. Before = production · After = this PR's preview deploy.

Scroll preview
Route Before (production) After (this PR's preview)
/ before / (scroll)
before / (scroll)
after / (scroll)
after / (scroll)

A short scroll-through clip (desktop) — click either thumbnail to open the full animation. Evidence for scroll-linked behavior a single screenshot can't show.

🟩 Safe / merged · 🟦 Advisory · 🟨 Held for review · 🟥 Blocked / closed


💰 Earn for open-source contributions like this. Gittensor lets GitHub contributors earn for the work they already do — register to start earning →.

Checked by LoopOver, a quiet PR intelligence layer for OSS maintainers.

  • Re-run LoopOver review

@loopover-orb loopover-orb Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LoopOver approves — the gate is satisfied and CI is green.

@loopover-orb
loopover-orb Bot merged commit 7b25d05 into JSONbored:main Jul 24, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gittensor:bug Gittensor-scored bug fix — scores a 0.05x multiplier.

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