Skip to content

docs(selfhost): add website docs accuracy audit checklist (#1829) - #4070

Merged
loopover-orb[bot] merged 1 commit into
JSONbored:mainfrom
andriypolanski:docs/selfhost-audit-checklist-1829
Jul 7, 2026
Merged

docs(selfhost): add website docs accuracy audit checklist (#1829)#4070
loopover-orb[bot] merged 1 commit into
JSONbored:mainfrom
andriypolanski:docs/selfhost-audit-checklist-1829

Conversation

@andriypolanski

Copy link
Copy Markdown
Contributor

Summary

  • Add apps/gittensory-ui/src/lib/selfhost-docs-audit.ts — shared manifest: self-host doc pages, source-of-truth rows (compose, env, release, Sentry/OTEL, backup, deploy scripts), loose-docs consolidation plan, and validation commands.
  • Add apps/gittensory-ui/src/routes/docs.self-hosting-docs-audit.tsx — website checklist page mapping docs to runtime files and CI drift guards.
  • Link the audit page from docs.maintainer-self-hosting.tsx and docs.index.tsx.
  • Add test/unit/docs-selfhost-audit-checklist.test.ts — drift guard that every manifest path exists, drift tests exist, npm scripts are real, and Sentry/REES scope notes are present.

Closes #1829

Scope

  • Docs accuracy checklist with source-of-truth links to runtime files
  • Website docs navigation audit (all self-host child pages listed + linked from maintainer index)
  • Loose docs consolidation plan (CONVERGENCE_RUNBOOK, config/examples, review-enrichment README, miner DEPLOYMENT)
  • Validation commands for docs/UI build
  • Sentry documented as opt-in with operator-owned DSN
  • REES analyzer auto-metadata explicitly out of scope (separate roadmap)
  • No application code changes under src/**

Prior partial work on main (#3191 release docs, #1823/#1824/#1943/#1944 drift tests) is referenced in the checklist rather than duplicated.

Changed files

File Change
apps/gittensory-ui/src/lib/selfhost-docs-audit.ts Audit manifest (pages, sources, loose docs, validation commands)
apps/gittensory-ui/src/routes/docs.self-hosting-docs-audit.tsx New checklist page
apps/gittensory-ui/src/routes/docs.maintainer-self-hosting.tsx Link to audit page
apps/gittensory-ui/src/routes/docs.index.tsx Maintainer hub link
apps/gittensory-ui/src/routeTree.gen.ts Generated route registration
test/unit/docs-selfhost-audit-checklist.test.ts Manifest + navigation drift guard

Validation

git diff --check
./node_modules/.bin/vitest run test/unit/docs-selfhost-audit-checklist.test.ts
npm run docs:drift-check
npm run ui:typecheck
npm run ui:lint
npm run ui:test
npm run ui:build
npm run test:ci
npm audit --audit-level=moderate

@andriypolanski
andriypolanski requested a review from JSONbored as a code owner July 7, 2026 23:08
@superagent-security

Copy link
Copy Markdown
Contributor

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

@codecov

codecov Bot commented Jul 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.60%. Comparing base (b679697) to head (541b9e1).
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4070   +/-   ##
=======================================
  Coverage   93.60%   93.60%           
=======================================
  Files         381      381           
  Lines       35627    35627           
  Branches    13070    13070           
=======================================
  Hits        33347    33347           
  Misses       1618     1618           
  Partials      662      662           
🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@loopover-orb loopover-orb Bot added the gittensor:feature Gittensor-scored feature linked to a feature issue — scores a 0.25x multiplier. label Jul 7, 2026
@loopover-orb

loopover-orb Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Tip

🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩

✅ Gittensory review result - approve/merge recommended

Review updated: 2026-07-07 23:23:18 UTC

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

✅ Suggested Action - Approve/Merge

  • safe to merge

Review summary
This PR adds a self-host docs accuracy audit checklist page plus a shared data manifest (pages, source-of-truth rows, loose-docs plan, validation commands) and a drift-guard test that asserts every referenced route file, runtime source path, drift-guard test file, and npm script actually exists on disk. It touches no src/** application code, only apps/gittensory-ui docs routes/lib and a new test/unit file, and wires the new page into the maintainer self-hosting index and docs hub. The manifest-driven approach with existsSync-based drift checks is a sound, low-risk way to keep the checklist honest, and the diff is coherent with the stated description and the linked issue (#1829).

Nits — 5 non-blocking
  • apps/gittensory-ui/src/routes/docs.self-hosting-docs-audit.tsx:43 links to issue roadmap(selfhost): production hardening and first release readiness #1819 as the 'roadmap' issue while the PR itself closes docs(selfhost): audit website docs against runtime defaults #1829 — worth a one-line clarification of how the two issue numbers relate so readers of the audit page aren't confused about which issue governs it.
  • apps/gittensory-ui/src/routes/docs.self-hosting-docs-audit.tsx: the SelfHostingDocsAudit component body is ~135 added lines with an inline table renderer; consider extracting the source-of-truth table into a small subcomponent for readability.
  • test/unit/docs-selfhost-audit-checklist.test.ts:38-46 only checks that each driftGuard file exists, not that it actually covers the paired topic/docsPath content — fine as a drift guard but worth noting it's a path-existence check, not a semantic one.
  • test/unit/docs-selfhost-audit-checklist.test.ts:5 imports isPublicSafeText from ../../src/signals/redaction, which isn't part of this diff — confirm that export still matches its current signature since the file wasn't provided for verification.
  • Extract the source-of-truth table markup in docs.self-hosting-docs-audit.tsx into a small presentational component to shrink the main component body.
Signal Result Evidence
Code review ✅ No blockers 1 reviewer
Linked issue ✅ Linked #1829
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: 145 registered-repo PR(s), 83 merged, 23 issue(s).
Contributor context ✅ Confirmed Gittensor contributor andriypolanski; Gittensor profile; 145 PR(s), 23 issue(s).
Gate result ✅ Passing No configured blocker found.
Review context
  • Author: andriypolanski
  • Role context: outside_contributor
  • Public audience mode: oss maintainer
  • Lane context: Repository is configured for direct PR review.
  • Public profile languages: TypeScript, JavaScript, Python, Rust, Cuda, Kotlin, MDX, Scala
  • Official Gittensor activity: 145 PR(s), 23 issue(s).
  • PR-specific overlap: none found.
Contributor next steps
  • Keep the PR focused and include validation evidence before maintainer review.
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.

🟩 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 Gittensory, a quiet PR intelligence layer for OSS maintainers.

  • Re-run Gittensory 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.

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

@loopover-orb
loopover-orb Bot merged commit 9ba80b6 into JSONbored:main Jul 7, 2026
9 checks passed
@loopover-orb loopover-orb Bot added gittensor:bug Gittensor-scored bug fix — scores a 0.05x multiplier. and removed gittensor:feature Gittensor-scored feature linked to a feature issue — scores a 0.25x multiplier. labels Jul 7, 2026
@JSONbored JSONbored added gittensor:feature Gittensor-scored feature linked to a feature issue — scores a 0.25x multiplier. and removed gittensor:bug Gittensor-scored bug fix — scores a 0.05x multiplier. labels Jul 9, 2026
@andriypolanski
andriypolanski deleted the docs/selfhost-audit-checklist-1829 branch July 16, 2026 15:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gittensor:feature Gittensor-scored feature linked to a feature issue — scores a 0.25x multiplier.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(selfhost): audit website docs against runtime defaults

2 participants