Skip to content

Latest commit

 

History

History
56 lines (42 loc) · 2.31 KB

INDEX.md

File metadata and controls

56 lines (42 loc) · 2.31 KB

Documentation index

Complete guide to the AgentsORG .design format (design.v1).

Start here

Doc Description
../README.md Project intro + quick start
overview.md System map with diagrams
ecosystem.md Figma, DTCG, Tailwind, shadcn, agents
design-md-mapping.md Google DESIGN.md / getdesign.md ↔ .design
../SPEC.md Normative specification
../PHILOSOPHY.md Why living visual contracts

How-to

Doc Description
../templates/starter.design Annotated kitchen-sink template — copy as .design and adapt
self-contained.md Drag-drop / in-file agent.instructions
drop-in.md Install .design in a product repo
shadcn.md Integrate shadcn/ui
getdesign.md Convert getdesign.md analyses
motion-media.md tokens.sound, video targets, and the HyperFrames frame.md export
human-authoring.md Write a strong contract
agent-consumption.md Agent READ/FOLLOW/UPDATE/VERIFY
lifecycle.md bootstrap → refine → lock → evolve

Context

Doc Description
comparison.md vs DESIGN.md, DTCG, AGENTS.md, products
skills-sh.md Agent Skill packaging
research.md Background decisions

Key diagrams

The largest mermaid diagrams live in:

  • overview.md — architecture, discovery, precedence, agent loop, lifecycle, token→CSS
  • shadcn.md — artifact roles, agent workflow
  • getdesign.md — conversion pipeline, sequence
  • agent-consumption.md — follow trees
  • lifecycle.md — status + locked paths

Examples & templates

Schema & skill