Skip to content

docs(commands): add @gittensory command reference page (#2171) - #3872

Merged
loopover-orb[bot] merged 5 commits into
JSONbored:mainfrom
rust-toml:feat/docs-gittensory-commands-2171-v3
Jul 6, 2026
Merged

docs(commands): add @gittensory command reference page (#2171)#3872
loopover-orb[bot] merged 5 commits into
JSONbored:mainfrom
rust-toml:feat/docs-gittensory-commands-2171-v3

Conversation

@rust-toml

Copy link
Copy Markdown
Contributor

Summary

  • Add /docs/gittensory-commands — generated reference for public Q&A verbs, maintainer queue digests, and PR action verbs (roles, descriptions, auto-review vs gate boundary).
  • Extend gen-command-reference to export action-catalog entries; link the help card to the new page.
  • Fix docs-drift and gen-command-reference unit fixtures; align generated command-reference.ts with prettier/eslint.

Fixes #2171

Scope

Validation

  • git diff --check
  • npm run command-reference:check
  • npm run docs:drift-check
  • npm run ui:lint (0 errors)
  • npm run ui:typecheck
  • npm run ui:test
  • npm run ui:build
  • npm run test:coverage on gen-command-reference, check-docs-drift, github-commands unit tests
  • npm audit --audit-level=moderate
  • Rebased on latest upstream/main (no conflicts)

Notes

Made with Cursor

rust-toml added 5 commits July 6, 2026 23:05
Document every Q&A, maintainer digest, and PR action verb with default
roles and the gate vs auto-review boundary; link from the help card.
The new command-reference docs route is listed in check-docs-drift;
unit-test fixtures must include it so synthetic drift checks keep passing.
collectCommandCatalogs now requires GITTENSORY_ACTION_COMMAND_CATALOG in
synthetic fixtures; add seven action entries so the 15-command floor test
still exercises extraction without throwing.
Emit prettier-compliant entry objects from gen-command-reference and use
design-token table classes on the gittensory-commands docs page.
Break long description fields at printWidth 100 so ui:lint passes without
post-generation fixes and command-reference:check stays in sync.
@rust-toml
rust-toml requested a review from JSONbored as a code owner July 6, 2026 22:02
@superagent-security

Copy link
Copy Markdown
Contributor

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

@loopover-orb loopover-orb Bot added the gittensor:bug Gittensor-scored bug fix — scores a 0.05x multiplier. label Jul 6, 2026
@loopover-orb

loopover-orb Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Tip

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

✅ Gittensory review result - approve/merge recommended

Review updated: 2026-07-06 22:18:46 UTC

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

✅ Suggested Action - Approve/Merge

  • safe to merge

Review summary
This is a docs-only PR that adds a new /docs/gittensory-commands reference page enumerating public Q&A, maintainer digest, and PR-action @​gittensory commands, and extends scripts/gen-command-reference.mjs to emit a new ACTION_COMMAND_ENTRIES export alongside the existing catalogs. The generator, generated command-reference.ts, docs-drift check, help-card link in commands.ts, and unit tests were all updated consistently, and CI (typecheck, lint, build, coverage, docs-drift) passed on this exact commit. The one soft spot is the hand-maintained DEFAULT_ROLE_SUMMARY map in the new route file, which duplicates default-role data that isn't generated or drift-checked against the actual authorization policy source.

Nits — 5 non-blocking
  • apps/gittensory-ui/src/routes/docs.gittensory-commands.tsx: DEFAULT_ROLE_SUMMARY hardcodes default roles per command id with no generation or drift-check tying it to the real RepositoryCommandAuthorizationPolicy defaults, so it can silently go stale if defaults change elsewhere.
  • scripts/gen-command-reference.mjs:76 introduces a bare magic number 7 for the action-command floor; consider a named constant alongside the existing MIN_TOTAL_COMMANDS for consistency.
  • apps/gittensory-ui/src/routes/docs.gittensory-commands.tsx: GittensoryCommandsReference is a fairly large single component (~64 lines); could be split slightly for readability but not required.
  • apps/gittensory-ui/src/routeTree.gen.ts is a generated file and shows up as a long-file/any-cast smell in tooling, but that's expected for this file type and not actionable.
  • Consider deriving DEFAULT_ROLE_SUMMARY in docs.gittensory-commands.tsx from the same source-of-truth used by RepositoryCommandAuthorizationPolicy defaults (or generate it via gen-command-reference.mjs) so docs can't drift from actual default authorization behavior.
Signal Result Evidence
Code review ✅ No blockers 1 reviewer
Linked issue ✅ Linked #2171, #3859
Related work ⚠️ 2 scoped overlaps Top overlaps are listed below; lower-confidence bulk is hidden.
Change scope ❌ 8/20 High review scope from cached public metadata (2 linked issues).
Validation posture ✅ 25/25 PR body includes validation/test evidence.
Contributor workload ✅ 10/10 Author activity: 3 registered-repo PR(s), 2 merged, 0 issue(s).
Contributor context ✅ Confirmed Gittensor contributor rust-toml; Gittensor profile; 3 PR(s), 0 issue(s).
Gate result ✅ Passing No configured blocker found.
Review context
Contributor next steps
  • Review top overlaps.
  • Add a concise scope and risk note.
  • Check active issues and PRs before submitting.
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

@codecov

codecov Bot commented Jul 6, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.53%. Comparing base (7d145f0) to head (2f1ee65).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3872   +/-   ##
=======================================
  Coverage   93.53%   93.53%           
=======================================
  Files         336      336           
  Lines       33281    33281           
  Branches    12175    12175           
=======================================
  Hits        31128    31128           
  Misses       1528     1528           
  Partials      625      625           
Files with missing lines Coverage Δ
src/github/commands.ts 98.16% <ø> (ø)
🚀 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 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 008a5d8 into JSONbored:main Jul 6, 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.

docs(commands): document the @gittensory PR command surface (verbs, roles, auto-review-vs-gate boundary)

1 participant