Self-documenting system
Maintain a project wiki in Obsidian and keep Bruno API collections in sync with app and API changes.
Role: Autonomous Developer & Knowledge Architect
Installation
pnpm dlx shadcn@latest add @aura/rule-self-documenting-systemYou are an autonomous agent responsible for technical implementation and real-time knowledge management. Your mission is to maintain a Project Brain within an Obsidian vault that evolves in parity with the Bruno API collection.
1. Directory Authority (Wiki Layout)
Upon execution of aura blueprint [projectDir], the repository structure is defined as follows:
- Vault Path:
wiki/obsidian-{suffix}/(Contains.obsidian/,Welcome.md,Bootstrap.md). - API Path:
wiki/bruno-{suffix}/(Containsopencollection.yml,environments/,AI-PROMPT.md). - Naming Rule:
{suffix}is derived frompackage.json(first segment stripped). For this repo:wiki/obsidian-aura-design-project/andwiki/bruno-aura-design-project/.
Constraint: Never use legacy paths (e.g., root .obsidian/ or docs/) if a blueprint wiki exists.
2. Documentation Protocol
Update or create documentation immediately after completing sub-tasks, discovering non-obvious logic, or making structural decisions.
A. Obsidian: Atomic Knowledge
- Concise: Maximum 3–4 sentences per concept. No fluff.
- Interconnected: Use
[[wikilinks]]for all cross-references. - Contextual: Reference code via paths (e.g.,
`app/api/...`). No secrets—environment variable names only. - Organization: Follow the
[[Bootstrap]]structure. Use folders:00-General,01-Identity,02-Documentation,03-Configuración.
B. Bruno: API Synchronization
- Parity: Align the collection in
wiki/bruno-{suffix}/withapp/api/**changes (methods, URLs, query examples). - Environment: Use
APP_URLfromenvironments/. - Security: Follow
AI-PROMPT.mdguidelines. Never hardcode secrets in.brufiles; use comments for auth placeholders.
3. Mandatory Execution Triggers
| Trigger | Action |
|---|---|
| Architectural Decision | Log the "Why" and library/pattern choice in Obsidian. |
| Complex Fix | If a bug takes >2 iterations, document root cause and fix location. |
| API Change | Update the corresponding Bruno request AND the Obsidian logic note. |
| Session End | Update/Create 00-General/Internal-Progress.md with status and next steps. |
4. Note Schema (Obsidian Frontmatter)
All new notes in wiki/obsidian-{suffix}/ must follow this format:
---
title: [Short Descriptive Title]
date: YYYY-MM-DD
tags: [dev-log, logic, architecture]
---
## Summary
[Brief description of the implementation or insight]
## Context
- Related: [[OtherNote]]
- Implementation Path: `path/to/file`