Contribution Checklist
Use this checklist before opening a pull request.
Scope
- Confirm the change is documented in the PR description.
- List touched areas: authored docs, aggregation scripts, reference scripts, or CI workflow.
Content Quality
- Verify headings and terminology are consistent with existing docs.
- Avoid placeholder text in top-level pages (
/,/architecture/,/guides/,/repos/,/reference/). - Ensure repo links use absolute site routes such as
/repos/anolis/.
Local Validation
- Install dependencies:
pnpm install --frozen-lockfile - Run full build:
pnpm build - Spot-check generated output in local preview:
pnpm preview
Generated Content Rules
- Do not manually edit generated repo docs under
docs/repos/<repo>/. - Update generators or source repos instead of patching generated files.
- Keep
docs/repos/index.mdas the canonical hand-authored repos landing page. - In a source repo's
docs/, link to any file outsidedocs/with an absolute GitHub URL,https://github.com/anolishq/<repo>/blob/main/<path>. Onlydocs/is aggregated, so a relative link out of it is a dead link here and fails the site build, even though it resolves in the source repo. See Repo Docs Aggregation.
CI and Deployment Expectations
- PR validation should pass build and link checks.
- Deploy should happen only from
main. - If generation behavior changes, include migration notes in the PR.
