agentleFS
IvanWng97IvanWng97/pixtuoid/site/AGENTS.md

pixtuoid / site

AGENTS.md551 starsChanged 31 days agoMITView on GitHub

The landing page: a self-contained Astro static site (NOT Rust) → GitHub Pages. A consumer of the Rust workspace's outputs — version, rendered docs, demo media all flow in from outside site/. Parent guide: the workspace ../AGENTS.md. Human detail: README.md. You are in the Astro consumer, not the Rust producer. Rust house rules (cargo/clippy, just preflight, the crate CI gates) do not apply to a site-only change. The gates here are just site-check (+ just site-fmt) and just site-e2e; the…

1 other project uses a version of this.

Adopted by

Most recently taken up by

  • Other versions1 project uses a version of this.

    Word for word · 1

    1. pixtuoid/pixtuoid★ 551100% same

    Edited · 0

    None found.

    Wrote their own version · 0

    None found.

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 31,542 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository4 other files it gives its agents.

The file

We split this AGENTS.md into the rules it gives an agent

2 rules. About 0 are common, 0 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Every generated artifact, manifest seam, and rendered-copy sharp edge: SINGLE-SOURCED.md — read it before touching this area.

    line 55
  2. Very specific:

    NO CSP; regressions surface in just site-e2e's console watchdog.

    line 67

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

site — agent guide

The landing page: a self-contained Astro static site (NOT Rust) → GitHub Pages. A consumer of the Rust workspace's outputs — version, rendered docs, demo media all flow in from outside site/. Parent guide: the workspace ../AGENTS.md. Human detail: README.md.

You are in the Astro consumer, not the Rust producer. Rust house rules (cargo/clippy, just preflight, the crate CI gates) do not apply to a site-only change. The gates here are just site-check (+ just site-fmt) and just site-e2e; the pre-push hook still runs just preflight.

Cross-boundary build inputs (the coupling that bites)

astro build reads these files from OUTSIDE site/ (workspace Cargo.toml + the docs/ pages below); a rename/move of any FAILS the build:

  • workspace Cargo.toml → displayed-version FALLBACK only; the primary source is the latest release tag (config/released-version.mjs, unit-tested — main runs ahead of the released version mid-cycle). Both workflows checkout with fetch-depth: 0. pages.yml deploys on push to main, not on tag push, so a fresh tag shows after the next main commit or a workflow_dispatch.
  • docs/{CONFIGURATION, ARCHITECTURE, CONTRIBUTING}.md → rendered routes via glob loaders in src/content.config.ts. Adding, renaming, or REMOVING a rendered doc is a multi-point edit: glob pattern, src/pages/*.astro, the DOCS entry in consts.ts (Nav.astro and Docs.astro's sidebar/pager derive from it; assert-docs-rendered is generic by design — it globs every rendered article.prose — and needs no edit), lighthouserc.json, and the smoke viewport table.

public/wasm/ is gitignored just gen-wasm output; without it the office silently stays on its poster. public/demos/ is gitignored too: just gen-media --only site renders it locally (before a build or dev server, which astro.config.mjs's demoAssets() fails on a missing demo, and before test:demos), and CI renders it per build.

The architecture diagram renders at build, in process (config/rehype-beautiful-mermaid.mjs — no browser); Playwright's Chromium is installed only for site.yml's e2e step. The empty-render class is gated by config/assert-docs-rendered.mjs (check:docs), whose header owns the mechanism; pages.yml's pins carry their own.

Docs shell: the doc routes (the DOCS manifest in consts.ts is the roster) mount the Statusline doc variant (no PR feed fetch); Docs.astro's sidebar reads the one FLOORS manifest. Blockquotes promote to terminal callouts (config/rehype-callouts.mjs, unit-tested, registered AFTER rehypeRepoLinks). Adding a .prose colour rule needs a twin under .callout__body — the specificity arithmetic and its theme-prefixed tie are on the rule itself in Docs.astro, and the smoke suite's callout AA sweep grades it.

Single-sourced content

Every generated artifact, manifest seam, and rendered-copy sharp edge: SINGLE-SOURCED.md — read it before touching this area.

CSP (hash-based, two coordinated halves in astro.config.mjs)

cspInlineHashes() in astro.config.mjs owns the WHY; config/csp-hashes.mjs owns the parse. The rules a page author needs: an is:inline script needs NO manual CSP step; a hand-written public/*.js loaded by URL rides script-src 'self'; an inline <style> or style attribute needs none either — each is hashed, an attribute's under 'unsafe-hashes', but one set at runtime (setAttribute('style', …), style.cssText, markup through innerHTML) is blocked: set el.style.<property> instead. astro dev serves NO CSP; regressions surface in just site-e2e's console watchdog.

Dev server (agent-driving)

just site-dev-bg daemonizes (astro dev --background, polls the dev-only /_astro/status endpoint); just site-dev-stop frees the port. Two edges: the status endpoint is dev-server only (astro's core/create-vite.js, at package.json's version, registers it under command === "dev"; astro preview daemonizes too but has nothing to poll), and dev/preview share port 4321 — stop the daemon before just site-e2e (its webServer fails loud on a squatted port). npm run lighthouse needs 4321 AND collect.previewPort free: its preview moves there so the gzip proxy can take the audited port.

Gates

just site-check = npm run verify (format:check → lint → check → knip → test:unit → test:demos → build → check:docs → audit). just site-e2e = Playwright vs the PRODUCTION build — the runtime-contract tier (__pixLights/pix:onair/ data-lit seams, scrollspy keys, docs-nav variant, reduced-motion, console watchdog) that tsc/knip/build are blind to. CI: site.yml / pages.yml.

  • Lighthouse (npm run lighthouse, in-repo runner config/lighthouse-runner.mjs, lighthouse's programmatic API, median of lighthouserc.json's numberOfRuns serial runs; runner-semantics pinned by its test — a renamed audit FAILS instead of passing vacuously). A category score is a budget, not a contract: color-contrast is a small weight in the a11y category, so a total contrast failure still clears the category budget — anything that must never regress gets its own per-audit assertion with aggregationMethod: pessimistic (median greens a binary audit that failed one run). Collect URLs pin ?theme=day (otherwise the wall clock picks the palette — half of CI runs would audit each). The theme matrix is smoke.spec.ts (day/night/dracula), not a doubled collect list. The audit runs THROUGH startPagesLikeProxy, which gzips the wasm as GitHub Pages does and astro preview doesn't. LCP, interactive and speed-index are sized at the office's wasm padded to its just gen-wasm-check cap, plus run spread (#1124; the first two again for pixtuoid-lofi 0.3, whose code, not its bytes, cost them time).
  • Fonts: WOFF2, font-display: optional, loaded before use (a preload; the captions' face: OfficeBackdrop's boot) — never swap (Ubuntu cold visits reflow past the CLS budget; font-layout.spec.ts reproduces it).
  • npm: audit runs LAST in verify (a live advisory would short-circuit the checks below it — #847/#849); CI runs it when a PR changes package.json or package-lock.json, and daily in audit.yml. npm pinned (packageManager + engine-strict); install scripts fail-closed (strict-allow-scripts, exact-version allowScripts, explicit fsevents denial) — review with npm install-scripts ls.
  • Nothing gates a STALE overrides entry: to retire one, fresh-resolve --package-lock-only in a scratch dir with and without it and diff the packages maps — npm audit cannot clear an entry (the retired chrome-launcher pin guarded a chain no advisory covered).

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.