Skip to content

docs(launch): miner quickstart by contribution lane (#252) - #918

Merged
JSONbored merged 2 commits into
JSONbored:mainfrom
oktofeesh1:feat/issue-252-miner-quickstart
Jun 19, 2026
Merged

docs(launch): miner quickstart by contribution lane (#252)#918
JSONbored merged 2 commits into
JSONbored:mainfrom
oktofeesh1:feat/issue-252-miner-quickstart

Conversation

@oktofeesh1

Copy link
Copy Markdown
Contributor

Fixes #252.

Adds /docs/miner-quickstart — a lane-first onboarding page that walks a miner through the full loop (install → login → doctor → plan → preflight → packet), organized by how they contribute.

What this adds

  • Five contribution lanes, each with the exact gittensory-mcp commands and flags for that path:
    • Direct PR, Issue-solving PR, Issue discovery, Docs & context, and Repo-specific lanes.
  • A "choose your lane" section that maps the contributor's intent to the repo's configured ParticipationLane (direct_pr / issue_discovery / split / inactive / unknown), read from agent plan and repo-decision.
  • JSON-output notes on every command (--json) for automation.
  • Redaction / privacy notes: source never leaves your machine, GITTENSORY_UPLOAD_SOURCE=false, local absolute paths redacted, and the PR packet is public-safe (scrubbed of economic/identity signals).
  • Validation expectations documented with the real --validation "status|command|summary" flag.
  • Linked from the docs index under Miners.

Acceptance criteria

  • Quickstart explains lane choice, install, auth, doctor, plan, preflight, PR packet generation, and validation expectations.
  • Docs avoid reward guarantees and public score-prediction language.
  • CLI commands match current MCP package behavior — verified against packages/gittensory-mcp/bin/gittensory-mcp.js.
  • MCP examples include JSON-output and redaction notes.

Public-output safety

Copy avoids reward guarantees and public score-prediction phrasing. test/unit/docs-miner-quickstart.test.ts mirrors the beta-onboarding doc test: it asserts command accuracy, all five lanes, JSON-output + redaction notes, and the absence of reward / "you will earn" / score-prediction / seed-phrase·mnemonic·private-key language.

Notes

  • Pure docs addition; apps/** is excluded from coverage, so no coverage impact. The new root unit test guards content/command accuracy and redaction.
  • routeTree.gen.ts regenerated by the TanStack router plugin.

🤖 Generated with Claude Code

Adds /docs/miner-quickstart, a lane-first onboarding page that walks a miner
through the full loop (install → login → doctor → plan → preflight → packet),
organized by how they contribute:

- Direct PR, issue-solving PR, issue discovery, docs/context, and repo-specific
  lanes, each with the exact gittensory-mcp commands and flags for that path.
- A "choose your lane" section maps the contributor's intent to the repo's
  configured ParticipationLane (direct_pr / issue_discovery / split / inactive /
  unknown), read from `agent plan` / `repo-decision`.
- Every command shows `--json` for automation; redaction notes cover the local
  privacy boundary (source never leaves the machine, GITTENSORY_UPLOAD_SOURCE=
  false, local paths redacted) and the public-safe PR packet.
- Copy avoids reward guarantees and public score-prediction language.

CLI syntax verified against packages/gittensory-mcp/bin/gittensory-mcp.js.
Linked from the docs index (Miners). test/unit/docs-miner-quickstart.test.ts
mirrors the beta-onboarding doc test: asserts command accuracy, all five lanes,
JSON-output + redaction notes, and absence of reward/score-prediction phrasing.

Fixes JSONbored#252

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@oktofeesh1
oktofeesh1 requested a review from JSONbored as a code owner June 19, 2026 05:43
@dosubot dosubot Bot added the size:L label Jun 19, 2026
@ghost

ghost commented Jun 19, 2026

Copy link
Copy Markdown

Note

Gittensory Gate skipped

PR closed before full evaluation. No late first comment was created.

Signal Result Evidence Action
Gate result ⚠️ Skipped #918 is no longer open. No action.

💰 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.

@ghost ghost added the gittensory:reviewed label Jun 19, 2026
@superagent-security

superagent-security Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

⚠️ Contributor trust inconclusive. Click here for more info: Superagent Dashboard

@superagent-security

Copy link
Copy Markdown
Contributor

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

@ghost

ghost commented Jun 19, 2026

Copy link
Copy Markdown

gittensory · advisory review

Reviewed 4 changed file(s) — two independent AI reviewers.

Changed files: apps/gittensory-ui/src/routeTree.gen.ts, apps/gittensory-ui/src/routes/docs.index.tsx, apps/gittensory-ui/src/routes/docs.miner-quickstart.tsx, test/unit/docs-miner-quickstart.test.ts

Suggested action:Safe to merge — both reviewers found no blocking issues.

Reviewer A · gpt-oss-120b — recommends ✅ merge
The PR adds a comprehensive miner‑quickstart documentation page, wires it into the route tree and navigation, and includes a focused test suite verifying the content and compliance with public‑safety guidelines. The changes are clean, respect the public/private sanitizer, and do not introduce breaking behavior.

Suggestions

  • Verify that the test's use of import.meta.dirname works in the project's vitest configuration (or adjust to import.meta.url if needed).
  • Run the UI build to ensure the new route appears correctly in the navigation and does not cause any TypeScript errors in the generated route types.

Worth double-checking

  • If import.meta.dirname is unsupported, the new test may fail and reduce coverage.
  • The new route must be included in any sitemap or search indexing logic if such exists; double‑check that no orphaned route handling is required.

Reviewer B · nemotron-3-120b-a12b — recommends ✅ merge
The PR adds a new documentation page for miner quickstart by contribution lane, including route integration, UI linkage, and comprehensive tests. The content correctly avoids forbidden public/private boundary terms, emphasizes the copilot-only nature, and includes proper safety notes about session tokens and source upload. The tests validate key phrases, lane types, JSON output, privacy boundaries, and absence of private context language.

No blocking issues spotted.

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

Route Viewport Before After
/docs desktop before desktop after desktop
mobile before mobile after mobile
/docs/miner-quickstart desktop before desktop after desktop
mobile before mobile after mobile

@codecov

codecov Bot commented Jun 19, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.60%. Comparing base (d34d021) to head (cf4e01a).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #918   +/-   ##
=======================================
  Coverage   96.60%   96.60%           
=======================================
  Files         109      109           
  Lines       14895    14895           
  Branches     5384     5384           
=======================================
  Hits        14390    14390           
  Misses        104      104           
  Partials      401      401           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@JSONbored JSONbored added the gittensor:priority Maintainer-selected Gittensor priority — scores a 1.5x multiplier. label Jun 19, 2026
@dosubot dosubot Bot added the lgtm label Jun 19, 2026
@JSONbored
JSONbored merged commit 9d0a43e into JSONbored:main Jun 19, 2026
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gittensor:priority Maintainer-selected Gittensor priority — scores a 1.5x multiplier.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(launch): create miner quickstart by contribution lane

2 participants