Repository navigation
docs: refresh documentation after the migration - #4
Merged
Merged
Conversation
- Root README: renamed repository (statewalker-knowledge), package table with npm links, the demo app, dependencies on other statewalker repositories, requirements (Node 24, pnpm via corepack), the scripts that exist, releases. Drop the webrun-http-events row: that package lives in webrun-wire. - notebook-build: pnpm install with peer dependencies, entry point, the missing `logger` option, the lower-level exports, current notebook-kit version. - notebook-db: fix the Node driver example (`newNodeDuckDb`, not `newDuckDb`), peer dependencies, export table, a precomputeQueries example. - notebook-site: SiteHandler comes from webrun-site-builder; fix the broken ../notebook-events link; show newPubSub for the event stream. - apps/demo: add a README on how to run it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DAiZN6XrTAdQpNN3eXEz2U
- Package READMEs now have these sections: what it is, why it exists, how to use, examples, internals, license. Headings state what each section shows. - The root and demo READMEs are operating manuals: the layout, how to run it, why it is built this way, what will surprise you, and a reference section. - The READMEs describe only the current code: no links to other repositories, no history. - Added the failure messages a reader will see, a dispatch diagram for notebook-site, and a known problem in the demo's onFailed logging. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DAiZN6XrTAdQpNN3eXEz2U
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
1 participant
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.
Rewrites the READMEs so they match the code as it is now. Documentation only; no code, config or lockfile changes.
newDuckDb, which@statewalker/db-duckdb-nodedoes not export. It isnewNodeDuckDb.SiteHandlercomes from@statewalker/webrun-site-builder.../notebook-eventslink.webrun-http-events, which is not a package in this workspace.loggeroption.Every export and example was checked against
src/.🤖 Generated with Claude Code
https://claude.ai/code/session_01DAiZN6XrTAdQpNN3eXEz2U