Astro Build Standards docs

Astro Build Standards

Everything that governs how a Miscreants Astro site is built. New here? Start with the Workflow router — find your task, read only the modules it needs.

Start here

Rules

The only place a rule is stated.

Checklists

What reviewers gate on.

Process & state

Reference


How this fits together

text
AGENTS.md ─────────► the contract: non-negotiables + where to go next
    │                (CLAUDE.md is a pointer to it, nothing more)
    ▼
docs/workflow.md ──► the router: task → modules → verification tier
    │
    ├──────────────► docs/rules/*.md ──────► the rules, stated once
    │                                        each carries a stable id
    │
    └──────────────► docs/checklists/*.md ─► the gates, citing those ids

Rules are cited by id, never by section number or page. Each rule declares one beside its heading:

md
### Client-side scripting
<!--rule: components.scripting | tier: required-->

Write [components.scripting] anywhere in the repo to cite it. Ids survive rules moving between files, which section numbers did not. npm run docs:build keeps the generated rule-links footer in each file current so every citation renders as a working link; npm run check fails on a citation to an id that doesn't exist.

bash
npm run docs:build      # refresh the rule-link footers
npm run docs:check      # citations, links, ids, footers

Generated from docs/*.md in astro-miscreants-starter-v1. The markdown remains the source of truth — regenerate after changes.