Skip to content

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

Description

@JSONbored

Context

apps/gittensory-ui's docs site already has docs.miner-quickstart.tsx and docs.miner-workflow.tsx, but zero pages mention MINER_CODING_AGENT_*, CodingAgentDriver, claude-cli, or codex-cli — despite the driver being production-wired per #5131/#5138. ORB's side already has an analogous page, docs.self-hosting-ai-providers.tsx, that this new page should mirror structurally.

Dependencies

None — independently shippable. It benefits from, but does not require, the ".gittensory-miner.env.example" issue and the "recognizing a stale/missing coding-agent credential" troubleshooting-table issue in this same batch: if the troubleshooting table lands first, this page should link to it instead of duplicating its content; if not, include a minimal inline version scoped to this page.

Requirements

  1. Add a new route file apps/gittensory-ui/src/routes/docs.miner-coding-agent.tsx.
  2. Follow the same structural conventions as docs.self-hosting-ai-providers.tsx (page layout, headings, code blocks, table components) and the existing docs.miner-quickstart.tsx/docs.miner-workflow.tsx (navigation/sidebar registration, page meta).
  3. Document provider selection: explain MINER_CODING_AGENT_PROVIDER's accepted values (noop/claude-cli/codex-cli/agent-sdk) and what each means operationally.
  4. Document model/timeout overrides: MINER_CODING_AGENT_CLAUDE_MODEL, MINER_CODING_AGENT_CODEX_MODEL, MINER_CODING_AGENT_TIMEOUT_MS.
  5. Include a "recognizing a stale or missing credential" troubleshooting section — link to the dedicated README table if it has already landed; otherwise include a minimal inline version scoped to this page only.
  6. Register the new route in the docs site's navigation/sidebar so it is actually reachable, not just a file that exists.
  7. This is a documentation-only route: it must not introduce any new env vars, config keys, or code/runtime behavior changes to the driver itself.

Deliverables / Acceptance Criteria

  • New file apps/gittensory-ui/src/routes/docs.miner-coding-agent.tsx
  • Page covers provider selection, model/timeout overrides, and credential troubleshooting
  • Route registered in the docs site's navigation
  • Cross-linked to/from docs.miner-quickstart.tsx and docs.miner-workflow.tsx where relevant
  • No application logic or env-var behavior changed

Test Coverage Requirements

This PR must ship with full test coverage for every changed line and branch — the repo's Codecov patch gate requires 99%+ coverage and the house standard is to aim for 100%, including both sides of every conditional/nullish-coalescing branch introduced. Add: (1) a render test asserting the new route mounts without throwing and contains the expected section headings, (2) an invariant test for "the documented list of accepted MINER_CODING_AGENT_PROVIDER values on this page never drifts from the actual accepted values in the driver-factory source" (e.g. a snapshot or literal-array comparison against the code-level provider list), and (3) a regression test is not applicable since this is a net-new doc page, not a bug fix — state that explicitly in the PR.

Expected Outcome

An operator configuring AMS's coding-agent driver has an in-app docs page — reachable from the same site as the quickstart/workflow docs — walking them through provider choice, model/timeout overrides, and credential troubleshooting, instead of having to read source code.

Links & Resources

Metadata

Metadata

Assignees

No one assigned

    Labels

    gittensor:featureGittensor-scored feature linked to a feature issue — scores a 0.25x multiplier.help wantedExtra attention is needed

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions