Skip to content

docs(readme): rewrite around what the package is - #57

Merged
TheGreatAxios merged 2 commits into
cl-9064-memory-add-shared-real-postgres-test-harness-in-testsfrom
cl-9176-memory-rewrite-readme-opening-to-say-what-it-is
Sep 27, 2026
Merged

TheGreatAxios merged 2 commits into
cl-9064-memory-add-shared-real-postgres-test-harness-in-testsfrom
cl-9176-memory-rewrite-readme-opening-to-say-what-it-is

Conversation

@TheGreatAxios

@TheGreatAxios TheGreatAxios commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Stacked on #56; merge that first.

  • The README opening now says what the package is (semantic and full-text document memory for Interchange, stored in Postgres/pgvector) and when to use it.
  • Environment variables move out of a quickstart paragraph into a Reference table (variable, required, default, meaning). Each default was checked against the source.
  • The internal terms "plane", "grant tags" and "sidecar bearer token" are replaced with plain wording.
  • The resident distiller is introduced once. The @corbits/cron wiring paragraph is now one line: the host decides when to mail mailTo.
  • The README Development section moves to CONTRIBUTING.md. The dead bun run dev line is dropped, because src/server.ts does not exist.
  • The runMemoryMigrations section says each run replays in one transaction behind an advisory lock, so every replica can call it at boot.
  • "Upgrading from 0.1" lists the helpers no longer exported from the package root, checked against npm 0.1.0's exports, and notes runMemoryMigrations now comes only from @corbits/memory/migrations.
  • The createResidentDistiller JSDoc example destructures { workflow, agent }, and its text matches the README.

Verification

  • bun run typecheck passes.
  • Every default in the Reference table was checked against src/mount-config.ts, src/core/embed-client.ts, src/core/rerank-client.ts and src/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

@TheGreatAxios TheGreatAxios left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
TheGreatAxios force-pushed the cl-9176-memory-rewrite-readme-opening-to-say-what-it-is branch from 712ba01 to 9c60724 Compare September 25, 2026 07:02
@TheGreatAxios
TheGreatAxios force-pushed the cl-9176-memory-rewrite-readme-opening-to-say-what-it-is branch 3 times, most recently from 20d21e1 to 6b78648 Compare September 26, 2026 00:53
@TheGreatAxios
TheGreatAxios force-pushed the cl-9176-memory-rewrite-readme-opening-to-say-what-it-is branch from 6b78648 to 8dc8cd9 Compare September 26, 2026 01:32
@TheGreatAxios TheGreatAxios changed the title Rewrite the README around what the package is docs(readme): rewrite around what the package is Sep 26, 2026
@TheGreatAxios
TheGreatAxios force-pushed the cl-9176-memory-rewrite-readme-opening-to-say-what-it-is branch from 8dc8cd9 to 3a01f02 Compare September 26, 2026 01:36
@TheGreatAxios
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
TheGreatAxios force-pushed the cl-9176-memory-rewrite-readme-opening-to-say-what-it-is branch from 3a01f02 to e2ece62 Compare September 27, 2026 00:32
@TheGreatAxios
TheGreatAxios merged commit d7ae8b8 into main Sep 27, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant