Skip to content

docs(miner-deployment): add laptop vs fleet deployment guide#3621

Merged
loopover-orb[bot] merged 1 commit into
JSONbored:mainfrom
kiannidev:docs/miner-deployment-2330
Jul 5, 2026
Merged

docs(miner-deployment): add laptop vs fleet deployment guide#3621
loopover-orb[bot] merged 1 commit into
JSONbored:mainfrom
kiannidev:docs/miner-deployment-2330

Conversation

@kiannidev

Copy link
Copy Markdown
Contributor

Summary

  • Add packages/gittensory-miner/DEPLOYMENT.md comparing laptop vs fleet form factors
  • Document laptop-mode status/doctor walkthrough and expected SQLite state layout
  • Document fleet-mode docker run pattern with mounted /data and runtime secrets
  • State client-side invariants and link from the miner package README

Closes #2330

Test plan

  • npx vitest run test/unit/miner-deployment-doc.test.ts --coverage
  • npm run build:miner

Made with Cursor

Closes JSONbored#2330

Document status/doctor walkthrough, fleet docker pattern, and invariants.

Co-authored-by: Cursor <cursoragent@cursor.com>
@kiannidev
kiannidev requested a review from JSONbored as a code owner July 5, 2026 19:42
@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 5, 2026
@loopover-orb

loopover-orb Bot commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Warning

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

⏸️ Gittensory review result - manual review recommended

Review updated: 2026-07-05 19:47:21 UTC

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

⏸️ Suggested Action - Manual Review

Review summary
This is a docs-only PR that adds packages/gittensory-miner/DEPLOYMENT.md contrasting laptop vs fleet deployment, links it from the package README, and adds a test asserting the doc contains required substrings and that the README links to it. The content is internally consistent (client-side invariants, config-dir override, docker run pattern with mounted /data and runtime-injected secrets) and closes the linked issue #2330. No source/schema/wiring changes are involved, so risk is minimal.

Nits — 5 non-blocking
  • test/unit/miner-deployment-doc.test.ts only asserts substring presence in the doc it reads, so it can't catch inaccurate or stale instructions inside those sections — it verifies the doc says the right words, not that the words are true.
  • DEPLOYMENT.md links to ../../docker-compose.yml and docs/miner-goal-spec.md relative to packages/gittensory-miner/ — worth double-checking those relative paths actually resolve from that directory.
  • The fleet-mode docker run example pins node:24-slim while the laptop-mode section requires Node.js >=22.13.0 only — consider a brief note on why 24 was chosen or align the versions for consistency.
  • Consider adding a short 'known limitations' bullet noting there's no published miner image yet (already stated in the fleet section) directly in the comparison table for visibility.
  • If GITTENSORY_MINER_CONFIG_DIR / XDG_CONFIG_HOME resolution chain is documented in @​jsonbored/gittensory-mcp docs, a direct link there would save readers a hop.
Signal Result Evidence
Code review ✅ No blockers 1 reviewer
Linked issue ✅ Linked #2330
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 ❌ 5/25 Preflight is holding this PR: the review lane is unavailable, so it is not ready for automated review.
Contributor workload ✅ 10/10 Author activity: 1458 registered-repo PR(s), 751 merged, 48 issue(s).
Contributor context ✅ Confirmed Gittensor contributor kiannidev; Gittensor profile; 1458 PR(s), 48 issue(s).
Gate result ✅ Passing No configured blocker found.
Review context
  • Author: kiannidev
  • Role context: outside_contributor
  • Public audience mode: oss maintainer
  • Lane context: Repository registration is not available in the local Gittensory cache.
  • Public profile languages: TypeScript, MDX, C++, HTML, Rust
  • Official Gittensor activity: 1458 PR(s), 48 issue(s).
  • PR-specific overlap: none found.
Contributor next steps
  • Await review-lane availability.
  • Refresh registry data or choose a registered active repo.
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 5, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.20%. Comparing base (29d59b6) to head (9532bb3).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3621   +/-   ##
=======================================
  Coverage   93.20%   93.20%           
=======================================
  Files         313      313           
  Lines       31900    31900           
  Branches    11673    11673           
=======================================
  Hits        29731    29731           
  Misses       1517     1517           
  Partials      652      652           
🚀 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 c0c97d5 into JSONbored:main Jul 5, 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(miner-deployment): write laptop-mode vs fleet-mode deployment guide

1 participant