Repository navigation
docs(readme): Interchange-style install and examples (CL-8775) - #8
Merged
Merged
Conversation
Registry add commands for @corbits/granola. Examples match public exports.
Use Quickstart / How it works / Development / License instead of Install / Use / Full example / Contributing.
Swap package README headings to Interchange names: Runtime support, Quickstart, How it works, Development, License. Keep registry add, not github:.
TheGreatAxios
force-pushed
the
cl-8775-readme-granola
branch
from
September 22, 2026 04:12
e24f72a to
e8825d1
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
Quickstart now leads with the entry point production actually mounts:
installGranolaIngestion(app, config)wirescreateGranolaBindingStore+ensureGranolaWebhook+createGranolaIngest+mountGranolaWebhookonto a host's Hono app — host-owned persistence, enrichment, and rendering passed in as the library's ownGranolaBindingsPort/GranolaTranscriptStore/GranolaKnowledgeCapture/GranolaIngestLifecycletypes, nothing faked.The plain client + tool definitions (root export, no hub dependency) moved to a "Lower-level" section, since
GRANOLA_TOOL_DEFINITIONS' handlers are stillnot implementedplaceholders — the README now says so instead of implying they work.Fixed two inaccuracies from the prior pass:
client.listNoteswas called with a non-existentlimitoption (real signature requiresfolderId), and the webhook payload example usedpayload.noteId(the real field isnote_id).Verification
README-only. Every export named was grep-checked against
src/tools/index.ts,src/ingress/index.ts, andsrc/ingest/index.ts. Both code fences were copied into a scratchreadme-check.tsat the repo root and typechecked with this repo's owntsc(bundler resolution, strict) — clean, no errors — then deleted.