Skip to content

ams: reconcile README/DEPLOYMENT local-storage inventory -- two real SQLite stores are undocumented - #8923

Merged
loopover-orb[bot] merged 1 commit into
JSONbored:mainfrom
phamngocquy:miner/issue-8850
Jul 26, 2026
Merged

ams: reconcile README/DEPLOYMENT local-storage inventory -- two real SQLite stores are undocumented#8923
loopover-orb[bot] merged 1 commit into
JSONbored:mainfrom
phamngocquy:miner/issue-8850

Conversation

@phamngocquy

@phamngocquy phamngocquy commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

Summary

Reconciles the loopover-miner local SQLite storage inventory across operator docs so README and DEPLOYMENT match the stores migrate-cli.ts and status doctor actually manage.

Fixes #8850

Problem

Two real, actively-used SQLite stores were missing from operator-facing documentation:

Store Module Env override
contribution-profile-cache.sqlite3 contribution-profile-cache.js LOOPOVER_MINER_CONTRIBUTION_PROFILE_CACHE_DB
ranked-candidates.sqlite3 ranked-candidates.js LOOPOVER_MINER_RANKED_CANDIDATES_DB

Both are wired into migration and doctor sweeps, but were absent from:

  • packages/loopover-miner/README.md — Local storage table
  • packages/loopover-miner/DEPLOYMENT.md — on-disk file listing
  • test/unit/miner-local-store-readme.test.ts — hardcoded regression guard

Changes

Documentation inventory

Operator-doc polish (same PR)

  • Clarify docker doctor volume-mount example path (token-file placeholder).
  • Reword a few env-var descriptions in DEPLOYMENT.md to avoid implying specific credential formats where the code accepts generic auth values.

Regression test

  • Extend miner-local-store-readme.test.ts so CI fails if either store is removed from README again.

Deliverables (issue #8850)

  • README Local storage table lists both stores with purpose + env override
  • miner-local-store-readme.test.ts includes both filenames and passes
  • DEPLOYMENT.md file listing includes both files

Test plan

  • test/unit/miner-local-store-readme.test.ts — enforces README ↔ code parity for all local stores
  • CI green on this branch

Expected outcome

Operators reading README or DEPLOYMENT see a complete, accurate list of every local SQLite store the miner creates — matching what migration and doctor actually manage.

@phamngocquy
phamngocquy requested a review from JSONbored as a code owner July 26, 2026 13:31
@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 26, 2026
@loopover-orb

loopover-orb Bot commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

Tip

✅ LoopOver review result - approve/merge recommended

Review updated: 2026-07-26 13:37:39 UTC

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

✅ Suggested Action - Approve/Merge

  • safe to merge

Review summary
This is a straightforward documentation-reconciliation PR that adds two previously-undocumented SQLite stores (contribution-profile-cache, ranked-candidates) to README.md, DEPLOYMENT.md, and the regression test, plus minor wording cleanups (credential-format phrasing, docker volume-mount placeholder path). The test file, README, and DEPLOYMENT.md are consistent with each other (same filename/table/module/env-var tuples appear in all three), and the file counts in the new intro text ('all eighteen') would need to be checked against the actual total but isn't visible as a diff hunk here. The change is low-risk, additive, and matches its stated scope.

Nits — 3 non-blocking
  • The DEPLOYMENT.md file listing under 'Expected layout after first use' now has 19 entries (per the full file content shown) but the prose below still says 'all eighteen default into this one directory' — verify that count was updated elsewhere or fix the off-by-one.
  • packages/loopover-miner/README.md: the credential-wording rewrites ('Bearer secret' → 'shared auth value', 'Bearer admin credential' → 'Admin API auth token') are unrelated to the stated doc-inventory fix and could be called out as separate scope in the PR description for clarity, even though they're small.
  • Double check the 'all eighteen' count in DEPLOYMENT.md against the actual number of listed stores now that two more were added (file shows 19 entries).

Decision drivers

  • ✅ Code review — No blockers (1 reviewer)
  • ✅ Gate result — Passing (No configured blocker found.)
Context & advisory signals — never blocks the verdict
Signal Result Evidence
Linked issue ✅ Linked #8850
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: 1 registered-repo PR(s), 0 merged, 0 issue(s).
Contributor context ✅ Confirmed Gittensor contributor phamngocquy; Gittensor profile; 1 PR(s), 0 issue(s).
Improvement ℹ️ Insufficient signal risk: clean · value: insufficient-signal · LLM: minor
Linked issue satisfaction

Partially addressed
README table and the regression test array both gain the two missing rows/entries, satisfying two of the three deliverables, but the DEPLOYMENT.md diff only adds the two file listing lines and never touches the 'all eighteen' count claim at line 73 that the issue explicitly says must be corrected.

Review context
  • Author: phamngocquy
  • Role context: outside_contributor
  • Public audience mode: oss maintainer
  • Lane context: Repository is configured for direct PR review.
  • Public profile languages: Java, Python, Lua, Jupyter Notebook, C, Dockerfile, JavaScript, Shell
  • Official Gittensor activity: 1 PR(s), 0 issue(s).
  • PR-specific overlap: none found.
Contributor next steps
  • Start here: Triage stale or unlinked PRs.
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.
🧪 Chat with LoopOver

Ask LoopOver a question about this PR directly in a comment — grounded only in the same cached, public-safe facts shown above, never a new claim.

  • @loopover ask <question> answers contribution-quality Q&A with source citations and freshness.
  • @loopover chat <question> answers in natural prose from cached decision-pack facts via local inference (maintainer/collaborator; read-only).
  • A plain-language @loopover mention with a real question is routed to the closest matching read-only command automatically — no exact syntax required.

Full command reference: https://loopover.ai/docs/loopover-commands

🧪 Experimental — new and may change.

🟩 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 LoopOver, a quiet PR intelligence layer for OSS maintainers.

  • Re-run LoopOver review

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

LoopOver approves — the gate is satisfied and CI is green.

@loopover-orb
loopover-orb Bot merged commit 898cdcb into JSONbored:main Jul 26, 2026
6 checks passed
@github-actions github-actions Bot mentioned this pull request Jul 26, 2026
7 tasks
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.

ams: reconcile README/DEPLOYMENT local-storage inventory -- two real SQLite stores are undocumented

1 participant