Self-documenting system
Guardrails for the Obsidian Project Brain and Bruno API parity. Write loops live in the update-project-brain skill.
Self-documenting system (guardrails)
Installation
pnpm dlx shadcn@latest add @aura/rule-self-documenting-systemDirectory authority
- Vault:
wiki/obsidian-{suffix}/(this repo:wiki/obsidian-aura-design-project/). - API catalog:
wiki/bruno-{suffix}/(this repo:wiki/bruno-aura-design-project/). - Suffix: from
package.jsonnamewith the first segment stripped (consumer apps). This monorepo vault is fixed asobsidian-aura-design-project. - MUST NOT: Use legacy root
.obsidian/ordocs/when a blueprint wiki exists.
When you must persist
| Trigger | Required outcome |
|---|---|
| Architectural decision | Obsidian note records the why and the library/pattern |
| Complex fix (>2 iterations) | Note records root cause and file path |
| API change | Bruno request + Obsidian logic note stay in parity |
| Session advance / end | New ## Sessions entry and pnpm brain:progress passes when that script exists |
Note shape
New notes under the vault MUST use frontmatter + short Summary / Context (see skill update-project-brain for the template and write steps).
- MUST: Keep notes atomic (about 3–4 sentences per concept), use
[[wikilinks]], cite code paths, never write secrets (env names only). - MUST: Follow
[[Bootstrap]]folders (00-General,01-Identity,02-Documentation,03-Configuración).
Execution
How to create/update notes, sync Bruno, and append Internal Progress is skill update-project-brain. This rule only states the obligation.