diff options
Diffstat (limited to 'AGENTS.md')
| -rw-r--r-- | AGENTS.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..42f57eb --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,33 @@ +# AGENTS.md + +Project-specific guidance for AI coding agents. + +<!-- ASTRYX:START --> +Astryx v0.7.2 · 173 components +CLI: run every command as `npx astryx <cmd>` (shown below as `astryx ...`). + +SETUP (once, in app entry e.g. main.tsx) — without these, components render unstyled: + import "@astryxdesign/core/reset.css"; + import "@astryxdesign/core/astryx.css"; + +WORKFLOW — start every page from a template, never from scratch: +1. `astryx build "<idea>"` — names the template to scaffold from and the parts it lacks. +2. `astryx template <name> <path>` — scaffold it; keep its frame, gap and padding; replace the content. +3. `astryx template <Block>` for parts it lacks; `astryx component <Name>` to read props before using one. +Changing an existing page? Keep it: skip step 2 and add blocks/components inside its sections. + +RULES: +- No <div> — components handle all layout and spacing. +- Read `astryx docs layout` before changing a template's frame. +- Dense data = rows (Table, List/Item), not Card-wrapped lists. Badge = counts only. +- Style with component props first, then tokens (var(--color-*|--spacing-*|--radius-*)). No raw hex/px. No StyleX/Tailwind compiler here — don't use xstyle/utility classes directly. Some templates use StyleX and need a compiler plugin; see `astryx docs styling-overview`. +- Palettes and custom colors go through the theme, never :root overrides. Run `astryx theme add <slug>` to import; `theme eject <slug>` only forks source. See `astryx docs theme`. +- SELF-CHECK: re-read the file; replace any raw <div>/<span>, imported .css/@apply, or hardcoded #hex/px with the component or a token. + +`astryx help` lists every command. Key ones beyond the workflow: + search "<query>" find any component / hook / doc / template + discover <words> integrations you could add + docs <topic> getting-started, principles, tokens, theme … (`astryx docs` lists all) + docs cli commands, API reference, integration authoring + upgrade --from <old version> --apply run after a dependency bump +<!-- ASTRYX:END --> |
