updated docs

This commit is contained in:
Shayan Rais
2026-03-06 12:56:26 +05:00
parent 588231dd5f
commit ba6cc3e6a0
6 changed files with 62 additions and 18 deletions
+22
View File
@@ -0,0 +1,22 @@
# Glob: **/*.md
## Documentation Standards
- Keep files focused and concise — one topic per file
- Use relative links between docs (e.g., `../best-practice/claude-memory.md`), not absolute GitHub URLs
- Include back-navigation link at top of best-practice and report docs (see existing files for pattern)
- When adding a new concept or report, update the corresponding table in README.md (CONCEPTS or REPORTS)
## Structure Conventions
- Best practice docs go in `best-practice/`
- Implementation docs go in `implementation/`
- Reports go in `reports/`
- Tips go in `tips/`
- Changelog tracking goes in `changelog/<category>/`
## Formatting
- Use tables for structured comparisons (see README CONCEPTS table as reference)
- Use badge images from `!/tags/` for visual consistency when linking best-practice or implementation docs
- Keep headings hierarchical — don't skip levels (e.g., don't jump from `##` to `####`)
+13
View File
@@ -0,0 +1,13 @@
# Glob: presentation/**
## Delegation Rule
Any request to update, modify, or fix the presentation (`presentation/index.html`) MUST be handled by the `presentation-curator` agent. Always delegate presentation work to this agent via the Task tool — never edit the presentation directly.
```
Task(subagent_type="presentation-curator", description="...", prompt="...")
```
## Why
The presentation-curator agent has three preloaded skills that keep it in sync with the presentation's structure, styling, and conceptual framework. It also self-evolves after every execution, updating its own skills to prevent knowledge drift. Bypassing the agent risks breaking slide numbering, level transitions, or style consistency.