Using with AI

The docs are also published as plain Markdown for AI coding assistants, so they use the real props and imports instead of guessing. The same files ship in the npm package and always match the installed version.

On the web

The docs site follows the llms.txt convention:

File Contents
/llms.txt Usage rules and a link to every page, with a one-line summary.
/llms-full.txt Every page in one file, with the demo code and the API tables.
/<page>.md One page as Markdown, e.g. /components/button.md for this site's Button page.

Point a chat assistant at llms-full.txt, or at the .md pages it needs.

In the package

The package contains the same content for the version you installed:

File Contents
node_modules/jarvis-react-ui/dist/llms.txt Usage rules and the page index.
node_modules/jarvis-react-ui/dist/llms-full.txt All pages with demo code and API tables.
node_modules/jarvis-react-ui/dist/api.json Every public component: entry point, props (type, default, description) and demo sources.

They are also exported as jarvis-react-ui/llms.txt, jarvis-react-ui/llms-full.txt and jarvis-react-ui/api.json, so tools can resolve them with require.resolve.

Tell your assistant

Coding agents read project instructions such as CLAUDE.md, AGENTS.md or .cursorrules. Add a short note so they load the docs before writing UI code:

## UI components

This app uses `jarvis-react-ui`. Before building or changing UI, read
`node_modules/jarvis-react-ui/dist/llms-full.txt` and use only the components, props and imports
documented there.

llms-full.txt is large. Agents that search files can read api.json or grep llms-full.txt for the component they need instead of loading all of it.

Let an assistant build windows

The files above help assistants that write code with the library. To let a model build UI at runtime, for example a voice assistant that opens a video window or a volume control, use the generative entry: the model sends JSON specs through tools, and UiRenderer renders them with library components. The package ships the JSON Schema (jarvis-react-ui/ui-schema.json) and ready-made tool definitions (jarvis-react-ui/ui-tools.json); see Connecting an assistant.