Skip to content

Open-source platform for 3D AI agents. Turn text or a photo into a rigged, animated GLB avatar, give it an LLM brain, memory and a wallet, and embed it anywhere with one web component. Remote MCP server, x402 payments, Three.js, browser-native.

1.4 KB
Raw Blame

docs/

Product and developer documentation for three.ws. Individual docs are served on the live site under /docs/<slug> and /tutorials/<slug>.

Start points:

  • start-here.md: the front door for both creators and developers, with the reference shelf at the bottom.
  • introduction.md and quick-start.md: the developer track.
  • ALL.md: generated single-file aggregate of the public docs (regenerate with node scripts/combine-docs.mjs; edit source files, never ALL.md).
  • api-reference.md: the REST API surface, with dedicated docs for the larger API families (crypto, 3D, market data, MCP).

Subdirectories: tutorials/ (step-by-step guides served on-site), specs/ (proposed contracts), api/, erc8004/, agent-abilities/, ux-flows/ (the UX Flow Atlas), content/ (use-case narratives), partners/.

Private trees, excluded from the public site build and from ALL.md by vite.config.js and scripts/combine-docs.mjs: ops/ (production runbooks), security/ (review records), internal/. Do not link to them from public docs.

Writing rules are in CLAUDE.md (Documentation section): every feature ships with its doc, every code sample runs, every link resolves, update rather than duplicate.