Context
The coding-agent driver (MINER_CODING_AGENT_PROVIDER, MINER_CODING_AGENT_CLAUDE_MODEL, MINER_CODING_AGENT_CODEX_MODEL, MINER_CODING_AGENT_TIMEOUT_MS) is already production-wired per the recently-merged driver construction work, but packages/gittensory-miner/README.md and packages/gittensory-miner/DEPLOYMENT.md never mention any of these four env vars. docs/coding-agent-driver.md documents the driver's internal interface, not operator-facing setup, leaving a real gap for anyone trying to configure a provider from scratch.
Dependencies
None — independently shippable. The underlying driver config is already live in the codebase, so this documentation reflects existing, shipped behavior rather than anticipating unshipped work.
Requirements
- Add a new section to
packages/gittensory-miner/README.md listing all four env vars: MINER_CODING_AGENT_PROVIDER, MINER_CODING_AGENT_CLAUDE_MODEL, MINER_CODING_AGENT_CODEX_MODEL, MINER_CODING_AGENT_TIMEOUT_MS.
- For
MINER_CODING_AGENT_PROVIDER, document the accepted values (noop/claude-cli/codex-cli/agent-sdk) and its default.
- For each of the other three vars, document its purpose and default value.
- Mirror the same section (or a cross-reference to it) in
packages/gittensory-miner/DEPLOYMENT.md, since that's the file operators use during actual deployment setup.
- Keep the framing operator-setup-focused ("how do I configure this"), distinct from
docs/coding-agent-driver.md's interface-level documentation ("how does this work internally") — cross-reference that file rather than duplicating its content.
- No code changes — this is a documentation-only PR.
Deliverables / Acceptance Criteria
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. Since this is a documentation-only change with no src/** lines touched, the Codecov patch gate itself will not apply meaningfully; instead add: (1) a lightweight drift-check test (or a documented manual verification step, if no test harness covers markdown content in this package yet) asserting the four env-var names as written in the docs actually match the names read in packages/gittensory-engine/src/miner/driver-factory.ts, (2) an invariant check that the documented default values match the code's actual defaults, and (3) no regression test is needed since this is not a bug fix.
Expected Outcome
An operator setting up gittensory-miner for the first time can find every coding-agent-driver env var, its accepted values, and its default in the README/DEPLOYMENT docs instead of having to read driver source code to discover them.
Links & Resources
Context
The coding-agent driver (
MINER_CODING_AGENT_PROVIDER,MINER_CODING_AGENT_CLAUDE_MODEL,MINER_CODING_AGENT_CODEX_MODEL,MINER_CODING_AGENT_TIMEOUT_MS) is already production-wired per the recently-merged driver construction work, butpackages/gittensory-miner/README.mdandpackages/gittensory-miner/DEPLOYMENT.mdnever mention any of these four env vars.docs/coding-agent-driver.mddocuments the driver's internal interface, not operator-facing setup, leaving a real gap for anyone trying to configure a provider from scratch.Dependencies
None — independently shippable. The underlying driver config is already live in the codebase, so this documentation reflects existing, shipped behavior rather than anticipating unshipped work.
Requirements
packages/gittensory-miner/README.mdlisting all four env vars:MINER_CODING_AGENT_PROVIDER,MINER_CODING_AGENT_CLAUDE_MODEL,MINER_CODING_AGENT_CODEX_MODEL,MINER_CODING_AGENT_TIMEOUT_MS.MINER_CODING_AGENT_PROVIDER, document the accepted values (noop/claude-cli/codex-cli/agent-sdk) and its default.packages/gittensory-miner/DEPLOYMENT.md, since that's the file operators use during actual deployment setup.docs/coding-agent-driver.md's interface-level documentation ("how does this work internally") — cross-reference that file rather than duplicating its content.Deliverables / Acceptance Criteria
packages/gittensory-miner/README.mdpackages/gittensory-miner/DEPLOYMENT.mddocs/coding-agent-driver.mdadded rather than content duplicatedTest 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. Since this is a documentation-only change with no
src/**lines touched, the Codecov patch gate itself will not apply meaningfully; instead add: (1) a lightweight drift-check test (or a documented manual verification step, if no test harness covers markdown content in this package yet) asserting the four env-var names as written in the docs actually match the names read inpackages/gittensory-engine/src/miner/driver-factory.ts, (2) an invariant check that the documented default values match the code's actual defaults, and (3) no regression test is needed since this is not a bug fix.Expected Outcome
An operator setting up
gittensory-minerfor the first time can find every coding-agent-driver env var, its accepted values, and its default in the README/DEPLOYMENT docs instead of having to read driver source code to discover them.Links & Resources
packages/gittensory-miner/README.mdpackages/gittensory-miner/DEPLOYMENT.mddocs/coding-agent-driver.md(interface-level doc to cross-reference, not duplicate)packages/gittensory-engine/src/miner/driver-factory.ts(source of truth for var names/defaults)