docs(gittensory-ui): fix stale website docs and add a CI docs-drift check - #3059
Conversation
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
gittensory-ui | 56ba276 | Commit Preview URL Branch Preview URL |
Jul 04 2026, 11:32 AM |
|
Superagent didn't find any vulnerabilities or security issues in this PR. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3059 +/- ##
=======================================
Coverage 96.11% 96.11%
=======================================
Files 263 263
Lines 28964 28964
Branches 10539 10539
=======================================
Hits 27838 27838
Misses 492 492
Partials 634 634 🚀 New features to boost your workflow:
|
|
Warning 🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨 ⏸️ Gittensory review result - manual review recommendedReview updated: 2026-07-04 11:35:27 UTC
⏸️ Suggested Action - Manual Review Review summary Nits — 6 non-blocking
Review context
Contributor next steps
Signal definitions
🟩 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.
|
…heck A full audit of the 30 docs.*.tsx pages found dead-flag claims, missing GITTENSORY_REVIEW_* flags, missing gate-mode dimensions, an undocumented 9-command maintainer queue-digest family, and schema-drifted API examples. Fixes all of it, plus adds scripts/check-docs-drift.mjs (wired into test:ci) so a new flag/command/gate-mode field shipped without a docs update fails CI instead of silently drifting. Fixes #3047
check-docs-drift.mjs's per-command substring check false-flagged docs.maintainer-workflow.tsx/docs.maintainer-install-trust.tsx once they switched to importing PUBLIC_COMMAND_LIST/MAINTAINER_COMMAND_LIST from the generated apps/gittensory-ui/src/lib/command-reference.ts (#3046) instead of hand-listing @gittensory commands inline. A page that imports the generated constants is already covered by command-reference:check, so skip its per-id checks.
1f50120 to
56ba276
Compare
Summary
apps/gittensory-ui/src/routes/docs.*.tsx) found stale/wrong content: dead-config claims documented as live (firstTimeContributorGrace), a stale "confirmed-contributor-gated" blocking claim duplicated across 3 pages, 4 missingGITTENSORY_REVIEW_*flags, 5 missing gate-mode dimensions (includingmoderationGateMode, shipped by feat(selfhost): add a modular moderation-rules engine with a cross-repo violation ledger #2746), an entire undocumented 9-command maintainer-only queue-digest family, schema-drifted JSON examples ondocs.branch-analysis.tsx/docs.scoreability.tsx, and fabricated claims ondocs.ai-summaries.tsx/docs.mcp-clients.tsx(a nonexistent model picker/CLI flag, a wrong generated MCP client command). All fixed.scripts/check-docs-drift.mjs, wired intotest:ciasdocs:drift-check, so a newGITTENSORY_REVIEW_*flag,@gittensorycommand, or gate-mode field shipped without a docs update fails CI instead of silently drifting — this is exactly the mechanism that let most of the above go unnoticed.Scope
type(scope): short summaryConventional Commit format.CONTRIBUTING.md; nosite//CNAME/VitePress/Pages changes.Validation
git diff --checknpm run actionlint(vianpm run test:ci)npm run typechecknpm run test:coveragelocally — full unsharded run, 8442 passed / 7 skipped across 418 files (vianpm run test:ci)npm run test:workersnpm run build:mcpnpm run test:mcp-packnpm run ui:openapi:checknpm run ui:lintnpm run ui:typechecknpm run ui:buildnpm audit --audit-level=moderate— 0 vulnerabilitiestest/unit/check-docs-drift-script.test.tscovering all three extractors, the manifest-coverage self-check, per-surface docs-gap detection, a real-repo regression guard, and a subprocess CLI smoke test.scripts/**is Codecov-ignored per this repo's config, so these aren't patch-coverage-gated, but they're real regression coverage.Safety
UI Evidence
Not applicable — every change in this PR is either docs text content (no layout/visual/component changes to any page) or a new Node CI script. I spot-checked the most heavily-edited pages (
docs.tuning,docs.scoreability,docs.mcp-clients,docs.maintainer-self-hosting) live in a browser during the audit and confirmed they render correctly, but there's no visual delta to screenshot.Notes
apps/gittensory-ui/src/lib/selfhost-env-reference.ts(stale line-number references) as part of a merge conflict against a fast-movingmain— a purenpm run selfhost:env-referenceregen, no manual edits.