docs(readme): rewrite around what the package is - #57
Merged
TheGreatAxios merged 2 commits intoSep 27, 2026
Conversation
TheGreatAxios
commented
Sep 25, 2026
TheGreatAxios
left a comment
Contributor
Author
There was a problem hiding this comment.
Self-review, two passes.
Verdict: ready for review.
- Every README claim was checked against
src/. - Review findings were fixed: the leftover "plane", the distiller wording now matching between README and JSDoc, and CONTRIBUTING keeping the unit-test and Ollama notes.
TheGreatAxios
force-pushed
the
cl-9176-memory-rewrite-readme-opening-to-say-what-it-is
branch
from
September 25, 2026 07:02
712ba01 to
9c60724
Compare
TheGreatAxios
force-pushed
the
cl-9176-memory-rewrite-readme-opening-to-say-what-it-is
branch
3 times, most recently
from
September 26, 2026 00:53
20d21e1 to
6b78648
Compare
TheGreatAxios
force-pushed
the
cl-9176-memory-rewrite-readme-opening-to-say-what-it-is
branch
from
September 26, 2026 01:32
6b78648 to
8dc8cd9
Compare
TheGreatAxios
force-pushed
the
cl-9176-memory-rewrite-readme-opening-to-say-what-it-is
branch
from
September 26, 2026 01:36
8dc8cd9 to
3a01f02
Compare
TheGreatAxios
added this pull request to stack #61
September 26, 2026 01:57
The function returns { workflow, agent, generatorAgentId }, not the
workflow alone.
The opening says what the package is and when to use it. Environment variables move from a quickstart paragraph into a Reference table. Undefined internal terms are replaced with plain wording, the resident distiller is introduced once, the cron wiring becomes one line, and the Development section moves to CONTRIBUTING.
TheGreatAxios
force-pushed
the
cl-9176-memory-rewrite-readme-opening-to-say-what-it-is
branch
from
September 27, 2026 00:32
3a01f02 to
e2ece62
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Stacked on #56; merge that first.
@corbits/cronwiring paragraph is now one line: the host decides when to mailmailTo.bun run devline is dropped, becausesrc/server.tsdoes not exist.runMemoryMigrationssection says each run replays in one transaction behind an advisory lock, so every replica can call it at boot.runMemoryMigrationsnow comes only from@corbits/memory/migrations.createResidentDistillerJSDoc example destructures{ workflow, agent }, and its text matches the README.Verification
bun run typecheckpasses.src/mount-config.ts,src/core/embed-client.ts,src/core/rerank-client.tsandsrc/core/fts-language.ts.Closes CL-9176
Closes CL-9177
Closes CL-9178
Closes CL-9179
Closes CL-9194
Closes CL-9328
Closes CL-9169