Skip to content

docs: use the preview build for visual proof #125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vyctorbrzezowski merged 1 commit into from
Aug 8, 2026
Merged

docs: use the preview build for visual proof #125

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion scripts/docs-site/AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Scope: docs shell generator, hidden visual fixtures, local smoke checks, and R2
- Keep authored docs under `docs/**` out of this subtree. Use virtual fixtures or generator code here when testing shell UI.
- The hidden component fixture is generated at `/__elements`; keep it `noindex` and out of `sitemap.xml` and `llms.txt`.
- Run `make docs-check` after renderer, shell CSS, visual fixture, asset, or smoke changes.
- Use `make docs-elements` to build and smoke the hidden fixture, then `make docs-serve` plus `make docs-elements-open` for visual review.
- For visual proof, run `DOCS_SITE_PREVIEW_INCLUDE_FIXTURE=1 npm run docs:build:preview`; do not rebuild the full locale corpus just to capture screenshots.
- After the preview build, use `make docs-serve` plus `make docs-elements-open` for visual review.
- Add smoke coverage in `scripts/docs-site/smoke.mjs` for any new visual contract that would be annoying to catch by eye later.
- Keep R2 uploads diff-friendly: no generated timestamp churn, randomized output, or broad rewrites unless the source docs changed.