diff --git a/AGENTS.md b/AGENTS.md index f92e0ff..283bf21 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -4,6 +4,8 @@ Basecoat is a vanilla JavaScript/HTML/CSS port of shadcn/ui components. It reuses shadcn/ui's design patterns and Tailwind CSS classes while maintaining semantic HTML, native browser elements, and full accessibility (ARIA attributes, proper hierarchies, keyboard navigation). The goal is to provide shadcn-quality components without React dependencies. +Basecoat is not a literal DOM port of shadcn/ui. It is an alternative implementation with the same visual language and comparable component coverage, but with simpler markup, less JavaScript, less CSS, and no React/runtime primitive dependency. + ## Quickstart - Install deps: `npm i` @@ -16,7 +18,7 @@ Basecoat is a vanilla JavaScript/HTML/CSS port of shadcn/ui components. It reuse - Edit sources only: - `src/css/base/base.css` – Shared base layer, tokens, and semantic utility classes - `src/css/components/*.css` – Component CSS classes (Tailwind + custom) - - `src/css/styles/style-*.css` – Style-pack overrides (`vega`, `nova`, `maia`, `lyra`, `mira`, `luma`, `sera`, `rhea`) + - `src/css/styles/style-*.css` – Style-pack visual rules (`vega`, `nova`, `maia`, `lyra`, `mira`, `luma`, `sera`, `rhea`) - `src/css/basecoat.css` – Aggregate CSS entrypoint - `src/js/*.js` – Individual component JS files (kebab-case, ESM) + `basecoat.js` (component registry) - `src/nunjucks/*.njk` and `src/jinja/*.html.jinja` – Component template macros @@ -47,14 +49,155 @@ Basecoat is a vanilla JavaScript/HTML/CSS port of shadcn/ui components. It reuse - `src/css/styles/style-luma.css` - `src/css/styles/style-sera.css` - `src/css/styles/style-rhea.css` -- Default aggregate and CDN behavior should resolve to Vega unless explicitly changed. -- Non-default styles should be selected by importing the relevant style file or using a style-specific bundled asset, not by introducing shadcn internal selector conventions. +- `basecoat.css` and the default CDN bundle remain Vega-compatible for Basecoat backward compatibility. This is a Basecoat compatibility decision; upstream shadcn/ui's current default generated config is Nova. +- Non-default styles must be selected through standalone style bundles (`basecoat-