molecule-core/docs
Hongming Wang eca9796a5b docs: sync documentation with 2026-04-13 merges (PRs #1-#8)
Covers today's quality + infra pass: brand/structural cleanup, MCP
per-domain refactor (1697 -> 89 lines, 87 tools), canvas ConfirmDialog
unification, 4 platform handler decompositions (+47 Go tests), E2E
hardening for Phase 30.1/30.6 auth, and two new CI jobs (e2e-api +
shellcheck).

- CLAUDE.md: updated test counts (Go 536, canvas 357, SDK 121, MCP 97,
  workspace 1084); documented MCP per-domain split + new api.ts; added
  handler-decomposition section; Phase 30.1/30.6 auth callout; new
  CI jobs; env vars cross-ref.
- PLAN.md: Phase 31 "Quality + Infra Pass" marked shipped; test totals
  refreshed to 2,295.
- README.zh-CN.md: license badge MIT -> BSL 1.1; added BSL license block.
- docs/api-protocol/platform-api.md: registry table gains Auth column
  documenting Phase 30.1 bearer-token and Phase 30.6 X-Workspace-ID
  requirements on heartbeat/update-card/discover/peers.
- docs/development/local-development.md: updated stale test counts;
  added e2e-api + shellcheck CI jobs; pointer to new testing-e2e.md.
- docs/development/testing-e2e.md: new — per-script reference, auth
  prerequisites, local run, CI coverage, adding-a-new-check checklist.
- docs/edit-history/2026-04-13.md: top-of-file summary section added
  spanning PRs #1-#8; preserves existing per-feature entries below.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-13 17:46:28 -07:00
..
.vitepress initial commit — Molecule AI platform 2026-04-13 11:55:37 -07:00
adapters initial commit — Molecule AI platform 2026-04-13 11:55:37 -07:00
agent-runtime initial commit — Molecule AI platform 2026-04-13 11:55:37 -07:00
api-protocol docs: sync documentation with 2026-04-13 merges (PRs #1-#8) 2026-04-13 17:46:28 -07:00
architecture initial commit — Molecule AI platform 2026-04-13 11:55:37 -07:00
assets/branding chore: replace brand icon and add HANDOFF.md 2026-04-13 13:03:40 -07:00
demo initial commit — Molecule AI platform 2026-04-13 11:55:37 -07:00
development docs: sync documentation with 2026-04-13 merges (PRs #1-#8) 2026-04-13 17:46:28 -07:00
edit-history docs: sync documentation with 2026-04-13 merges (PRs #1-#8) 2026-04-13 17:46:28 -07:00
frontend initial commit — Molecule AI platform 2026-04-13 11:55:37 -07:00
plugins initial commit — Molecule AI platform 2026-04-13 11:55:37 -07:00
product initial commit — Molecule AI platform 2026-04-13 11:55:37 -07:00
research initial commit — Molecule AI platform 2026-04-13 11:55:37 -07:00
.gitignore initial commit — Molecule AI platform 2026-04-13 11:55:37 -07:00
api-reference.md initial commit — Molecule AI platform 2026-04-13 11:55:37 -07:00
architecture.md initial commit — Molecule AI platform 2026-04-13 11:55:37 -07:00
ecosystem-research-outcomes.md initial commit — Molecule AI platform 2026-04-13 11:55:37 -07:00
ecosystem-watch.md initial commit — Molecule AI platform 2026-04-13 11:55:37 -07:00
index.md initial commit — Molecule AI platform 2026-04-13 11:55:37 -07:00
known-issues.md initial commit — Molecule AI platform 2026-04-13 11:55:37 -07:00
package-lock.json initial commit — Molecule AI platform 2026-04-13 11:55:37 -07:00
package.json initial commit — Molecule AI platform 2026-04-13 11:55:37 -07:00
quickstart.md initial commit — Molecule AI platform 2026-04-13 11:55:37 -07:00
README.md chore: structural cleanup — dead dirs, moves, gitignore 2026-04-13 14:06:52 -07:00
remote-workspaces-readiness.md initial commit — Molecule AI platform 2026-04-13 11:55:37 -07:00

docs/

This directory serves two purposes:

  1. Markdown content — everything under architecture/, agent-runtime/, api-protocol/, development/, frontend/, plugins/, product/, etc. This is what agents and humans read.
  2. VitePress site.vitepress/config.ts, package.json, package-lock.json. These drive the rendered documentation site.

Local preview

cd docs
npm install
npm run dev      # preview on http://localhost:5173
npm run build    # static build to docs/.vitepress/dist/

Conventions

  • New top-level docs must be linked from PLAN.md, README.md, and CLAUDE.md — otherwise agents can't find them (see .claude/ memory feedback_cross_reference_docs.md).
  • edit-history/YYYY-MM-DD.md is append-only log of significant changes; don't rewrite history.
  • archive/ holds one-shot analyses and retired docs — kept for context but not maintained.

Why site tooling lives here (not in docs-site/)

VitePress expects its config at <root>/.vitepress/config.ts where <root> is also the content directory. Splitting tooling into a sibling docs-site/ would require a non-trivial srcDir shim and break relative links in .vitepress/config.ts. Keeping both together is the pragmatic choice; this README is the tradeoff ledger.