Skip to content

Agent context

This site is structured so AI coding agents working in vibesmith projects can grab context quickly without filesystem walks into the private framework repo.

If the agent needs to…Read
Build a new feature against the frameworkQuick start
Avoid common R3F mistakes before writing codeAnti-patterns
Render many copies of one objectCookbook: instancing
Add or cross-fade authored animationsCookbook: animations
Measure what’s slowCookbook: perf debugging
Understand WebGL hard limitsReference: webgl-constraints
Respect performance budgetsReference: performance-budgets
Translate a Unity pattern to R3FReference: engine-patterns
Pick a material role / understand shader sharingReference: material-system
Author or query a sceneReference: scene-construction
  • llms.txt at site root — flat manifest of pages and intent, designed for agent-side indexing. Stable URL; follow the emerging llms.txt convention.
  • This page (/agents/) — narrative index that an agent’s first hit on the site resolves to.
  • The MCP server (@vibesmith/mcp-server, registered via .mcp.json in scaffolded projects) will gain read_recipe / read_doc / search_framework_knowledge tools that query this site server-side. Until those land, agents should fetch URLs directly.
  • Code first. Snippets are working JSX/TS, not pseudo-code.
  • Caveats explicit. Every recipe has a “Watch out for” section.
  • Game-agnostic. Examples use generic entities (props, characters, particles). Consumer game vocabulary lives in each consumer’s docs/game/.
  • Anti-patterns are numbered + stable. #NN-slug cross-references in recipes link to specific anti-pattern entries. Never renumbered.

Treat docs as a snapshot. The framework is pre-MVP and changes weekly; the cookbook lags real practice. If a recipe contradicts what’s in the codebase, the codebase wins — but flag it as a doc bug so it gets updated.