docs: refresh documentation after the migration - #4
Merged
Merged
Conversation
- Root README: list the nine actual packages (drop the nonexistent shared-intents, add shared-commands and shared-slots) with npm links; describe consumers, requirements (Node 24, pnpm via corepack), the real root scripts, CI, and the changesets/Renovate release flow with a link to statewalker/.github; remove the stale workspace:* cross-repo note and the history/* branches that do not exist on the remote. - Package READMEs: add entry point and export lists verified against src/index.ts; fix stale or wrong statements (shared-ids alphabet and Node version, shared-logger adapter key/default level, shared-logger-pino newPinoLogger/destination/browser mode, shared-commands nonexistent Commands.composed/filtered factories, shared-slots keyed getSnapshot). - Root package.json description: drop "intents". Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DAiZN6XrTAdQpNN3eXEz2U
- Root README becomes an operating manual: layout with dependency diagram, how to run it, why it is built this way (dist with a source condition, unbundled ESM, split logger, catalog), what will surprise you (typecheck before build fails with TS2307, write vs check scripts, frozen lockfile, publish-all), and a command/file reference. No references to other repositories. - Package READMEs use What it is / Why it exists / How to use / Examples / Internals / License; entry point and API lists move into How to use. - Add examples for getAdapter, waitFor/waitForSettled, extractTime and Crockford encoding; add failure modes with the real error text (adapter not found, unknown log level, slot and registry RangeErrors, CommandError messages, builder errors, pino invalid level). - shared-commands: restore What it is / Why it exists without history. - shared-logger-pino: rewritten in the package shape. - Describe current behaviour only (no past versions or migrations). 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.
Documentation-only refresh. No code, config, lockfile or CHANGELOG changes. READMEs describe the current state only, without references to other repositories.
distexports with asourcecondition, unbundled ESM, logger split from pino, pnpm catalog, root biome config); what will surprise you (TS2307 when typechecking before building,lint/formatwrite files, frozen lockfile,publish-allbypasses changesets); commands and file reference. Removed the nonexistentshared-intentspackage and thehistory/*branches section (those branches do not exist).src/index.ts; examples for each main export; failure modes with the real error text (checked against the builtdist). Corrections:parseSnowflakeformat-detection pitfalls.app.logger, no parent lookup, default levelinfofromLOG_LEVEL, invalidLOG_LEVELthrows; removed the nonexistent OpenTelemetry backend.newPinoLogger(stderr destination, browser mode), thectx.loggerside effect, argument mapping; removed the claim that init awaits an async transport.Commands.composed/filteredfactories; documentedpassthrough, policy presets, builder and registry errors, output-validation details.getSnapshotoverload, plain-slot dispose semantics, observer arrays.getAdapterdefault (no parent lookup), new examples.package.jsondescription: dropped "intents".🤖 Generated with Claude Code
https://claude.ai/code/session_01DAiZN6XrTAdQpNN3eXEz2U