Repository navigation
docs: refresh documentation after the migration - #2
Merged
Merged
Conversation
- Root README rewritten as an operating manual: package layout and dependency graph, package table with npm links, requirements (Node 24, pnpm via corepack), the root scripts, design reasons, known surprises, release process. - Every package README rewritten to one structure (what, why, how to use, examples, internals, license), with every export and example checked against src. Removed APIs that do not exist (runPickDirectory, loadFragment, resolver.resolve(), setWorkspace, DOCK_LAYOUT_STORAGE_KEY, ...), added missing `.promise` on command calls, documented failure modes with their actual messages. - New READMEs for platform.node, webapp.core, webapp.browser and workspace-vcs.core. - package.json descriptions fixed where stale or wrong (platform.*, inline.core, mime.core, render.core). - backbone.core src/_vendor/README.md and workspace-vcs.core CONTEXT.md: factual corrections only. 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.
Refreshes the documentation to match the current code.
src.runPickDirectory,loadFragment,resolver.resolve(),setWorkspace,DOCK_LAYOUT_STORAGE_KEY..promiseto command calls.descriptionfixed where it was stale or wrong: platform.core, platform.browser, platform.node, inline.core, mime.core, render.core. No other fields changed.backbone.core/src/_vendor/README.mdandworkspace-vcs.core/CONTEXT.md.No code, config, lockfile or CHANGELOG changes.
🤖 Generated with Claude Code
https://claude.ai/code/session_01DAiZN6XrTAdQpNN3eXEz2U