Skip to content

docs(miner): expand README local storage table (#4876) - #5490

Merged
JSONbored merged 1 commit into
JSONbored:mainfrom
RealDiligent:feat/readme-local-storage-4876
Jul 12, 2026
Merged

docs(miner): expand README local storage table (#4876)#5490
JSONbored merged 1 commit into
JSONbored:mainfrom
RealDiligent:feat/readme-local-storage-4876

Conversation

@RealDiligent

Copy link
Copy Markdown
Contributor

Summary

  • Expand the README Local storage table from 4 stores to all 14 SQLite files the miner package creates
  • Cross-link docs/env-reference.md for env-var overrides
  • Extend miner-local-store-readme.test.ts to drift-check the full inventory

Closes #4876

Test plan

  • npx vitest run test/unit/miner-local-store-readme.test.ts

@RealDiligent
RealDiligent requested a review from JSONbored as a code owner July 12, 2026 23:07
@superagent-security

Copy link
Copy Markdown
Contributor

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

@codecov

codecov Bot commented Jul 12, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.74%. Comparing base (f0426b5) to head (04134f2).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5490   +/-   ##
=======================================
  Coverage   94.74%   94.74%           
=======================================
  Files         563      563           
  Lines       44823    44823           
  Branches    14669    14669           
=======================================
  Hits        42467    42467           
  Misses       1621     1621           
  Partials      735      735           
Flag Coverage Δ
shard-1 43.84% <ø> (-0.50%) ⬇️
shard-2 35.41% <ø> (+0.03%) ⬆️
shard-3 31.66% <ø> (-0.29%) ⬇️
shard-4 31.63% <ø> (+0.24%) ⬆️
shard-5 33.09% <ø> (-0.11%) ⬇️
shard-6 43.83% <ø> (+0.27%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

List every SQLite store the miner package creates and extend the README drift test to lock the full inventory.

Co-authored-by: Cursor <cursoragent@cursor.com>
@loopover-orb loopover-orb Bot added the gittensor:bug Gittensor-scored bug fix — scores a 0.05x multiplier. label Jul 12, 2026
@loopover-orb

loopover-orb Bot commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Tip

🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩

✅ Gittensory review result - approve/merge recommended

Review updated: 2026-07-12 23:20:57 UTC

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

✅ Suggested Action - Approve/Merge

  • safe to merge

Review summary
Docs-only PR that expands the README's Local storage table from 4 to 14 SQLite stores, adds a cross-link to docs/env-reference.md, and extends the drift-check test to assert every file/table/module/env-var token is present in the README. The operations-runbook.md reference context lists the same 9 core stores plus laptop-state, consistent with this table's contents, and the test correctly iterates each row's tokens against the actual rendered README. Closes #4876 and is scoped tightly to documentation plus its own test — no production code touched.

Nits — 5 non-blocking
  • The governor-state row lists only `governor_scalar_state` as the 'Primary table(s)' in the table header but the cell also includes `governor_reputation_history` and `governor_own_submissions` — worth double-checking those two extra tables actually exist in governor-state.js since the test only asserts the first one.
  • Laptop bootstrap's env var column shows `GITTENSORY_MINER_CONFIG_DIR (path only)` rather than a dedicated override, which is inconsistent with the other 13 rows — consider a footnote clarifying why this one row diverges from the per-store env var pattern.
  • Consider asserting the second/third table names for governor-state.sqlite3 in the test as well, since the README cell lists three tables but the test only checks one token per row.
  • The docs/env-reference.md cross-link is a nice touch — confirm that file is up to date with all 14 stores' env vars via `npm run miner:env-reference` as mentioned in the README's own instructions.
  • nit: packages/gittensory-miner/README.md:100 still says every store resolves via the store-specific env var above, but the laptop bootstrap row lists only GITTENSORY_MINER_CONFIG_DIR, so tighten that sentence or make the laptop exception explicit.
Signal Result Evidence
Code review ✅ No blockers 1 reviewer
Linked issue ✅ Linked #4876
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: 293 registered-repo PR(s), 138 merged, 24 issue(s).
Contributor context ✅ Confirmed Gittensor contributor RealDiligent; Gittensor profile; 293 PR(s), 24 issue(s).
Gate result ✅ Passing No configured blocker found.
Improvement ⚠️ ℹ️ Insufficient signal risk: clean · value: insufficient-signal — Nothing measurable for the structural-improvement analyzers on this PR (e.g. no code files changed).
Review context
  • Author: RealDiligent
  • 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: 293 PR(s), 24 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 &lt;question&gt; answers contribution-quality Q&A with source citations and freshness.
  • @gittensory chat &lt;question&gt; 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

🟩 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 733d0a9 into JSONbored:main Jul 12, 2026
16 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. manual-review Gittensor contributor context

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update the README's "Local storage" table

2 participants