Merge pull request #1026 from PR0M3TH3AN/codex/revise-css-build-pipeline-documentation

Document deploy-time Tailwind build
This commit is contained in:
thePR0M3TH3AN authored and GitHub committed 2025-11-03 11:49:17 -05:00
commit fe25ea00a8
2 files changed
+16 -16

No files matched your search

+15 -15
View File
@@ -132,7 +132,7 @@ package scripts to keep formatting, linting, and generated output consistent:
```bash
npm run format # normalize CSS/HTML/JS/MD sources with Prettier + tailwindcss plugin
npm run lint:css # enforce design token usage and guard against raw hex colors
npm run build # rebuild css/tailwind.generated.css from tailwind.source.css
npm run build # run the Tailwind build locally (output remains gitignored)
```
- **No hard-coded colors:** Follow the token-first rules in `AGENTS.md`—reach
@@ -146,15 +146,15 @@ npm run format # format CSS/HTML/JS/MD with Prettier + tailwindcss pl
npm run lint # run CSS, hex color, inline-style, design-token, and Tailwind color/bracket guards in one pass
npm run lint:css # enforce token usage and forbid raw hex colors
npm run lint:inline-styles # fail CI if inline style attributes or element.style usage slip in
npm run build # rebuild css/tailwind.generated.css from tailwind.source.css
npm run build # run the Tailwind build (delegates to npm run build:css)
npm run build:beacon # bundle torrent/dist assets and re-run the inline-style guard
npm run build:beacon:bundle # bundle beacon assets without running the guard (rarely needed)
```
#### Admin runbook: regenerate Tailwind styles
Need to refresh `css/tailwind.generated.css` after token or template changes?
Run these commands from the repo root:
Need to confirm Tailwind picks up token or template changes? Run these
commands from the repo root:
1. Install dependencies (only required after cloning or when packages change):
@@ -162,16 +162,16 @@ Run these commands from the repo root:
npm install
```
2. Rebuild the Tailwind bundle (the output is gitignored and regenerated
automatically in CI/deploys):
2. Rebuild the Tailwind bundle for local verification (the output stays
gitignored and CI/Netlify handle deploy-time generation):
```bash
npm run build
npm run build:css
```
Commit only the source changes (e.g., updates in `css/tailwind.source.css` or
token files); the generated stylesheet is produced on demand during local
development and by CI/deploy automation.
The generated `css/tailwind.generated.css` artifact is ignored in git. CI
workflows and Netlify deploys run `npm run build` to produce the compiled
stylesheet during deployment, so source changes are all you need to commit.
Inline styles are intentionally blocked. `npm run lint:inline-styles` scans HTML
and scripts for `style=` attributes, `element.style`, or `style.cssText` usage
@@ -212,11 +212,11 @@ calls over to the facades above so upgrades stay painless.
The build command compiles Tailwind with `tailwind.config.cjs`, runs it through
the PostCSS pipeline defined in `postcss.config.cjs` (for autoprefixing), and
emits the purged, minified stylesheet at `css/tailwind.generated.css`. Commit the
regenerated file alongside any template changes so deployments pick up the
latest styles. This generated bundle is the only stylesheet we ship—reference
`css/tailwind.generated.css` everywhere and avoid vendoring older `tailwind.min.css`
artifacts.
emits the purged, minified stylesheet at `css/tailwind.generated.css`. That
bundle is generated automatically during CI/Netlify deploys and remains
gitignored locally; reference `css/tailwind.generated.css` in templates, but do
not commit the compiled file. Avoid vendoring legacy `tailwind.min.css`
artifacts now that the deploy pipeline owns the build step.
### Logo usage
+1 -1
View File
@@ -2,7 +2,7 @@
bitvid's visual language is now powered by Tailwind utilities backed by our design tokens. This document lists the primitives available via `css/tailwind.source.css`, how they behave across states, and when to mix them with Tailwind utilities.
All templates and embeds must load `css/tailwind.generated.css`; that compiled bundle is the only stylesheet shipped with the app. Remove any lingering references to legacy `tailwind.min.css` assets when porting surfaces into the design system.
All templates and embeds must load `css/tailwind.generated.css`; that compiled bundle is the only stylesheet shipped with the app. The file is generated during CI/Netlify deploys (and remains gitignored locally), so commit only the source styles that feed the build. Remove any lingering references to legacy `tailwind.min.css` assets when porting surfaces into the design system.
> **UI Styling:** For day-to-day decisions, start with the [Styling & Theming Rules](../AGENTS.md#styling--theming-rules-token-first) in `AGENTS.md` and the [CSS build pipeline overview](../README.md#css-build-pipeline). Run `npm run lint:css` before committing so design-token regressions are caught early.