forked from molecule-ai/molecule-core
|
|
||
|---|---|---|
| .. | ||
| .vitepress | ||
| adapters | ||
| agent-runtime | ||
| api-protocol | ||
| architecture | ||
| assets/branding | ||
| demo | ||
| development | ||
| edit-history | ||
| frontend | ||
| guides | ||
| marketing | ||
| plugins | ||
| product | ||
| research | ||
| runbooks | ||
| tutorials | ||
| .gitignore | ||
| api-reference.md | ||
| architecture.md | ||
| ecosystem-research-outcomes.md | ||
| ecosystem-watch.md | ||
| glossary.md | ||
| index.md | ||
| known-issues.md | ||
| package-lock.json | ||
| package.json | ||
| quickstart.md | ||
| README.md | ||
| remote-workspaces-readiness.md | ||
| workspace-runtime-package.md | ||
docs/
This directory serves two purposes:
- Markdown content — everything under
architecture/,agent-runtime/,api-protocol/,development/,frontend/,plugins/,product/, etc. This is what agents and humans read. - 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, andCLAUDE.md— otherwise agents can't find them (see.claude/memoryfeedback_cross_reference_docs.md). edit-history/YYYY-MM-DD.mdis 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.