For AI Agents
This documentation is designed to be consumed by AI coding agents as plain markdown. All endpoints are static files regenerated on every build from the TypeScript source, so the prop information is always current.
Endpoints
| Endpoint | Content |
|---|---|
/llms.txt | Index: one line per page with title, URL and description |
/llms-full.txt | The entire documentation as a single markdown document, prop tables included |
/md/<component>.md | One markdown file per UI component (e.g. /md/button.md), containing the description, usage snippets and the full prop table |
Suggested workflow
- Fetch
/llms.txtto discover what exists. - Fetch
/md/<component>.mdfor each component you need to use — it contains every prop with its type, default and description. - For project-wide questions (theming, setup), fetch
/llms-full.txt.
Ground rules for generated code
- Import components from
@gg-software/ui; import@gg-software/ui/styles.cssonce at the app entry. - The library is a client component bundle (
'use client'); don’t pass function props to it from React Server Components. - Spacing props (
gap,padding,margin) accept theSpaceValuescale:'xxs' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl', a pixel number, or a CSS length string. - Style with the exported
tokensobject (CSS variable references) instead of hard-coded colors, so light/dark themes keep working.