jawz/NixOS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

reviewing

Browse Source
This commit is contained in:
Danilo Reyes
2026-01-30 16:42:29 -06:00
parent 5da9abf1b7
commit d448e0f6c8
13 changed files with 271 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
specs/001-ai-docs/quickstart.md
View File

@@ -1,7 +1,7 @@
# Quickstart: AI-Facing Repository Constitution
1) Read the constitution (`docs/constitution.md`) to understand repo rules, conventions, and precedence for AI.
2) Use the reference map (`docs/reference/index.md`) to locate relevant paths (module categories, hosts, secrets files, proxy rules, stylix schemes).
3) Follow the appropriate use-case playbook (adding module/server/script/host/secrets) under `docs/playbooks/`; ensure steps reference helpers (e.g., mkserver) and secrets placement.
4) Validate against the checklist: full category/host coverage, secrets map completeness, discoverability within two navigation steps, constitution precedence defined.
5) When repo structure or rules change, update constitution, playbooks, and reference map together, logging the decision in Clarifications.
1) Start with the constitution at `docs/constitution.md` for scope, terminology, proxies, secrets map, and precedence (constitution overrides human docs for AI).
2) Navigate with the reference map at `docs/reference/index.md` (module directories, hosts/roles, auto-import filters, proxy helpers, secrets map, stylix).
3) Run the correct playbook from `docs/playbooks/` (`add-module`, `add-server`, `add-script`, `add-host-toggle`, `add-secret`) and keep secureHost gating in mind.
4) Validate outcomes using the audit checklist in `docs/reference/index.md` (coverage of categories/hosts, secrets completeness, proxy rules, discoverability ≤2 steps).
5) If rules or structure change: update `docs/constitution.md`, refresh affected playbooks and `docs/reference/index.md`, then record the decision and date in `specs/001-ai-docs/research.md`.