DocsComponents
Getting StartedComponentsCLIReleases

AGENTS.md

The in-repo manual coding agents read before touching the library.

The library documents itself in-repo, for agents working inside the package. If you are consuming it, the handbook you are reading now is the right document.

WhereWhat it is
packages/native-ui/AGENTS.mdThe package manual — stack, rules, the three component patterns, sizing, theming, testing, and an index table of every component
packages/native-ui/src/components/<name>/AGENTS.mdOne file per component, covering its own design decisions in full
packages/native-ui/README.mdThe human-facing introduction

What it covers that this site does not

  • The reasoning behind each component's edge cases, in full — why Spinner's arc caps are butt, why Checkbox's fill radius is a number rather than a token, why Tabs' settle lives in onFinalize rather than onEnd.
  • The compound-component file layout, and the five load-bearing properties of the closing Object.assign.
  • The displayName convention: every component carries a DelacourUI.-prefixed name matching its dotted path in the public API, enforced by a test that reads the source as text.
  • How to add a component, end to end.

src/docs.test.ts fails the build for a component folder with no AGENTS.md, for a doc that is only a heading, and for a component missing from the package doc's index table. Documentation is a build gate there, not a convention.

Pointing an agent at this site instead

For an agent writing app code against the package, start from /llms.txt — it indexes every page here, and any page can be fetched as Markdown by appending .md to its URL.

LLMs.txt

Machine-readable copies of every page on this site.

On this page

What it covers that this site does notPointing an agent at this site instead