Skip to content

docs: refresh documentation after the migration - #11

Merged
mkotelnikov merged 2 commits into
mainfrom
docs/refresh
Oct 5, 2026
Merged

mkotelnikov merged 2 commits into
mainfrom
docs/refresh

Conversation

@mkotelnikov

Copy link
Copy Markdown
Contributor

Documentation refresh. No code, config, lockfile or CHANGELOG changes.

Changes

  • Root README rewritten as an operating manual for this repository. The old one described backbone, platform, workspace and AI packages that are not in this repository. It now covers the 15 view packages, the source layout, building and testing (Node 24, pnpm via corepack), how a host app wires the fragments, failure modes with the text users see, commands, and the changesets release flow.
  • Package READMEs: each one checked against src/index.ts and its re-exports. Each now has the entry points (., ./fragment, ./styles), peer dependencies, examples using real exports, and failure modes. Stale claims fixed:
    • DirectoryPickerEmptyState is in ui.view.react, and workspace.view.react has no named exports.
    • mime.view.markdown has its own <Markdown> component and no longer uses a chat package.
    • Layout restore reads the LayoutStore adapter, not localStorage.
    • SpecRenderer has a handlers prop.
    • Old package names and pinned versions removed.
  • New READMEs for ai-local-models.view.react and webapp.view.react.
  • PACKAGE_README.template.md now follows the README section order.
  • package.json description fields fixed for the root, explorer.view.react (there is no tree, context menu or search panel) and workspace.view.react (it does not export AppWorkspaceProvider, DirectoryPickerEmptyState or ReconnectBanner).

Found while checking the docs (not changed here)

  • .github/workflows/release.yml only runs when the repository is statewalker/statewalker-workbench, so it never runs in this repository. ci.yml is still an inline workflow and does not call the shared one.
  • shell.view.react's JsonPanel renders SpecRenderer without handlers, so spec actions in dock tabs do nothing.
  • ai-local-models.view.react imports @json-render/react directly instead of going through render.view.react. The registry it puts into json:catalogs has empty handlers.
  • workspace.view.react hard-codes the product name "SandClaw" in its header label.
  • Several packages declare dependencies they never import, for example workspace.view.react in inline.view.react, settings.view.react and the mime.view.* packages.

🤖 Generated with Claude Code

https://claude.ai/code/session_01DAiZN6XrTAdQpNN3eXEz2U

mkotelnikov and others added 2 commits October 5, 2026 09:33
- Root README: rewritten as an operating manual for this repository (it
  described the backbone/platform/workspace/AI packages that live elsewhere).
  Lists the 15 view packages, layout, how to build and test with pnpm via
  corepack on Node 24, how a host wires the fragments, failure modes, commands
  and the changesets release flow.
- Package READMEs: every one checked against src/index.ts and its re-exports;
  added entry-point tables, peer dependencies and failure modes; fixed stale
  claims (DirectoryPickerEmptyState now lives in ui.view.react;
  workspace.view.react has no named exports; Markdown no longer comes from a
  chat package; layout restore reads LayoutStore, not localStorage;
  SpecRenderer has a handlers prop; old package names; pinned versions).
- New READMEs for ai-local-models.view.react and webapp.view.react.
- PACKAGE_README.template.md follows the README section order.
- package.json descriptions: root, explorer.view.react (no tree, context menu
  or search panel exist) and workspace.view.react (no AppWorkspaceProvider,
  DirectoryPickerEmptyState or ReconnectBanner exports).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01DAiZN6XrTAdQpNN3eXEz2U
@mkotelnikov
mkotelnikov merged commit 1111efa into main Oct 5, 2026
2 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