docs(engine): document the Rent-a-Loop pipeline modules - #5868
Conversation
Add a Rent-a-Loop pipeline README section covering the three pure, side-effect-free customer-facing modules idea-intake.ts, loop-progress.ts, and results-payload.ts (idea -> running loop -> delivered result): what each decides, its key exported types, and a runnable usage snippet per module. Snippet outputs were captured by running each module's real logic against the current exports. Docs-only; matches the package README's per-module style. Closes JSONbored#5813
|
Superagent didn't find any vulnerabilities or security issues in this PR. |
|
Tip 🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩 ✅ LoopOver review result - approve/merge recommendedReview updated: 2026-07-14 20:31:51 UTC
✅ Suggested Action - Approve/Merge
Review summary Nits — 5 non-blocking
Linked issue satisfactionAddressed Review context
Contributor next steps
Signal definitions
[BETA] Chat with GittensoryAsk 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.
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 LoopOver, a quiet PR intelligence layer for OSS maintainers.
|
Closes #5813.
Adds a
## Rent-a-Loop pipelinesection topackages/loopover-engine/README.mddocumenting the three pure customer-facing modules that had zero README coverage —idea-intake.ts(#4779),loop-progress.ts(#4800),results-payload.ts(#4801) — in the same per-module style as the rest of the package README (explanation + key exported types + a runnable snippet each).Docs-only — a single
.mdfile, no code changed. Percodecov.yml, coverage is only collected oversrc/**/packages/loopover-engine/src/**/packages/loopover-miner/lib/**, so no Codecov gate fires (expected).Deliverable
One umbrella section (idea → running loop → delivered result) with three subsections:
validateIdeaSubmission→buildTaskGraph→scoreTaskGraph→buildClaimPlan; documentsIdeaSubmission,TaskGraph,TaskGraphScore,ClaimPlan, and the text-cap constants.buildProgressSnapshot+progressChanged; documentsLoopPhase,LoopRunStatus,ProgressSnapshot,MAX_PROGRESS_ACTIVITY.buildResultsPayload; documentsIterationResult,ResultsPayload,MAX_DIFF_PREVIEW_FILES.It states explicitly that all three are pure/side-effect-free (no IO, network, wall-clock, or random reads), per the issue.
Validation
IdeaValidationResultdiscriminated union andClaimPlandisposition buckets).tsx) — the commented outputs (scoreTaskGraphverdict,ClaimPlanbuckets, theProgressSnapshotincl.percentComplete: 40, and theResultsPayloadsummary/totals) are the actual returned values, not hand-written.