Skip to content

docs(miner): add coding-agent docs page - #5444

Merged
JSONbored merged 2 commits into
JSONbored:mainfrom
taillred:fix/miner-deployment-docs-audit
Jul 12, 2026
Merged

docs(miner): add coding-agent docs page#5444
JSONbored merged 2 commits into
JSONbored:mainfrom
taillred:fix/miner-deployment-docs-audit

Conversation

@taillred

Copy link
Copy Markdown
Contributor

Summary

Add the new /docs/miner-coding-agent page and wire it into the docs UI. This PR updates the docs route, navigation, command palette, index page, quickstart/workflow cross-links, and route tests; it also trims the deployment docs to stop duplicating stale configuration claims.

Scope

  • The PR title follows type(scope): short summary Conventional Commit format, for example fix(api): restore profile access checks.
  • This PR is focused and does not mix unrelated backend, UI, MCP, docs, dependency, and deploy changes.
  • This follows CONTRIBUTING.md and does not reintroduce GitHub Pages, VitePress, site/, or CNAME.
  • I linked a currently open issue this PR resolves (e.g. Closes #123) — a linked open issue is required for every contributor PR.

Closes #5174

Validation

  • git diff --check
  • npm run actionlint
  • npm run typecheck
  • npm run test:coverage locally; codecov/patch requires ≥99% coverage of the lines AND branches you changed (aim for 100% on your diff so CI variance does not fail near the threshold). Global coverage is a non-blocking trend with a loose 90% backstop, not the gate.
  • npm run test:workers
  • npm run build:mcp
  • npm run test:mcp-pack
  • npm run ui:openapi:check
  • npm run ui:lint
  • npm run ui:typecheck
  • npm run ui:build
  • npm audit --audit-level=moderate
  • New or changed behavior has unit/integration tests for new branches, fallback paths, and sanitizer boundaries

If any required check was skipped, explain why:

  • Skipped the broader suite because this is a narrow docs/UI follow-up; verified the focused docs and deployment-docs audit tests directly.

Safety

  • No secrets, wallet details, hotkeys, coldkeys, user PATs, private keys, raw trust scores, private rankings, or private maintainer evidence are exposed.
  • Public GitHub text stays sanitized, low-noise, and does not imply compensation guarantees or optimization tactics.
  • Auth, cookie, CORS, GitHub App, Cloudflare, or session changes include negative-path tests.
  • API/OpenAPI/MCP behavior is updated and tested where needed.
  • UI changes use live API data or real empty/error/loading states, not production mock/demo fallbacks.
  • Public docs/changelogs are updated where needed; changelogs are only edited for release-prep PRs.

UI Evidence

Route Viewport Before After
/docs desktop before /docs
production
after /docs
preview
/docs mobile before /docs (mobile)
production
after /docs (mobile)
preview
/docs/miner-coding-agent/test desktop before /docs/miner-coding-agent/test
production
after /docs/miner-coding-agent/test
preview
/docs/miner-coding-agent/test mobile before /docs/miner-coding-agent/test (mobile)
production
after /docs/miner-coding-agent/test (mobile)
preview

Before = production. After = this PR's preview deploy.

Notes

  • This is a replacement PR for the closed attempt.
  • The deployment docs audit now passes locally.

@taillred
taillred requested a review from JSONbored as a code owner July 12, 2026 19:45
@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:feature Gittensor-scored feature linked to a feature issue — scores a 0.25x multiplier. label Jul 12, 2026
@loopover-orb

loopover-orb Bot commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Warning

🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨

⏸️ Gittensory review result - manual review recommended

Review updated: 2026-07-12 20:08:47 UTC

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

⏸️ Suggested Action - Manual Review

  • Touches a guarded path — held for manual review: This PR changes guardrail-protected path(s): apps/gittensory-ui/src/components/site/command-palette.tsx (matched apps/gittensory-ui/**), apps/gittensory-ui/src/components/site/docs-nav.tsx (matched apps/gittensory-ui/**), apps/gittensory-ui/src/routes/docs.index.tsx (matched apps/gittensory-ui/**), apps/gittensory-ui/src/routes/docs.miner-coding-agent.test.tsx (matched apps/gittensory-ui/**), apps/gittensory-ui/src/routes/docs.miner-coding-agent.tsx (matched apps/gittensory-ui/**), and 3 more.

Review summary
This PR adds a new /docs/miner-coding-agent page documenting the coding-agent provider/env-var/credential surface, wires it into route tree, nav, command palette, docs index, and adds cross-links from miner-quickstart and miner-workflow plus a route test. It also trims DEPLOYMENT.md to stop duplicating the provider list that now lives in the new page. The route wiring in routeTree.gen.ts follows the exact pattern of the surrounding entries, and the test suite includes a real assertion (docs.miner-coding-agent.test.tsx) that MINER_CODING_AGENT_PROVIDER_ITEMS stays in sync with the engine's CODING_AGENT_DRIVER_NAMES constant, which is a genuine parity check rather than a fabricated test.

Nits — 6 non-blocking
  • apps/gittensory-ui/src/routes/docs.miner-coding-agent.test.tsx:5 imports CODING_AGENT_DRIVER_NAMES directly from packages/gittensory-engine/src/miner/driver-factory via a relative cross-package path — confirm that's the intended way to reference engine constants from ui tests rather than through a published/aliased import, since it couples the UI test suite to the engine package's internal file layout.
  • apps/gittensory-ui/src/routes/docs.miner-coding-agent.tsx: the review brief flags MinerCodingAgentDriverDocs as a large function (97 lines), but it's a flat declarative JSX tree with no branching logic, so this is stylistic rather than a maintainability risk.
  • packages/gittensory-miner/DEPLOYMENT.md:12-18 now points to README.md and docs/coding-agent-driver.md instead of restating the env vars — worth double-checking those two targets actually still contain the provider/env-var details this page used to inline, so the trim doesn't leave a broken promise.
  • test/unit/docs-miner-quickstart.test.ts's reformatting of the existing `expect(normalizedSource).toMatch(...)` call onto multiple lines is unrelated churn to the feature and could be reverted to keep the diff minimal.
  • Consider adding a small drift-guard test asserting the DEPLOYMENT.md links (README.md#coding-agent-driver-configuration, docs/coding-agent-driver.md) resolve to real anchors/files, mirroring the self-hosting-docs-audit pattern already in the repo.
  • Touches a guarded path — held for manual review — A maintainer must review and merge this change.
Signal Result Evidence
Code review ✅ No blockers 1 reviewer
Linked issue ✅ Linked #5174
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: 53 registered-repo PR(s), 34 merged, 1 issue(s).
Contributor context ✅ Confirmed Gittensor contributor luckydicer; Gittensor profile; 53 PR(s), 1 issue(s).
Gate result ⚠️ Not blocking Advisory; not blocking this PR.
Improvement ✅ Minor risk: clean · value: minor — Code changes are accompanied by test evidence.
Review context
  • Author: luckydicer
  • 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: 53 PR(s), 1 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.
[BETA] Chat with Gittensory

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

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

Full command reference: https://gittensory.aethereal.dev/docs/gittensory-commands

Visual preview
Route Viewport Before (production) After (this PR's preview) Diff
/docs desktop before /docs after /docs
/docs mobile before /docs (mobile) after /docs (mobile)
/docs/miner-coding-agent/test desktop before /docs/miner-coding-agent/test after /docs/miner-coding-agent/test
/docs/miner-coding-agent/test mobile before /docs/miner-coding-agent/test (mobile) after /docs/miner-coding-agent/test (mobile)

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

🟩 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 added the manual-review Gittensor contributor context label Jul 12, 2026
@JSONbored
JSONbored merged commit b85fd78 into JSONbored:main Jul 12, 2026
31 checks passed
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. manual-review Gittensor contributor context

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a docs-site page for enabling Claude Code / Codex as the miner's coding-agent driver

2 participants