with one click
aikit-readme
// AIKit component README structure — Features, Usage, Props table, Styling with CSS variables. Use when creating or editing a component's README.md file.
// AIKit component README structure — Features, Usage, Props table, Styling with CSS variables. Use when creating or editing a component's README.md file.
AIKit component-creation checklist. Use whenever creating a new component under `src/components/<level>/<Name>/`, editing a level barrel (`src/components/<level>/index.ts`), or modifying `package.json#exports`. Ensures the component is reachable from the main entry, has a dedicated subpath export, and is listed in `docs/COMPONENTS.md` and `llms.txt`.
AIKit Storybook conventions — Docs.mdx and *.stories.tsx structure, story types (Playground, Default, Variants, Edge Cases), decorators. Use when creating or editing any file under a component's __stories__/ directory.
AIKit Playwright Component Testing conventions — helpersPlaywright.tsx, *.visual.spec.tsx, Docker-required test execution, one test per story, screenshots for portal-mounted dialogs. Use when creating or editing files under a component's __tests__/ directory.
| name | aikit-readme |
| description | AIKit component README structure — Features, Usage, Props table, Styling with CSS variables. Use when creating or editing a component's README.md file. |
Read docs/guidelines/readme.md and follow it when writing or updating a component README.