📁 Subsystem Deep Dive

services/MagicDocs/

📁 services/MagicDocs/ 📄 6 files

Tutorial: MagicDocs

MagicDocs acts as an automated, background archivist for your software project. It passively watches for files marked with a special header and, during pauses in your conversation, activates a silent sub-agent to update them. This ensures your documentation stays in sync with the latest code insights without interrupting your workflow or polluting the main conversation history.

flowchart TD A0["Magic Doc Identification"] A1["The Magic Docs Sub-Agent"] A2["Update Lifecycle Hooks"] A3["Context Isolation"] A4["Dynamic Prompt Templating"] A2 -->|"Triggers detection"| A0 A2 -->|"Activates"| A1 A3 -->|"Isolates environment"| A1 A0 -->|"Supplies metadata"| A4 A4 -->|"Instructs"| A1

Chapters

  1. Magic Doc Identification
  2. Update Lifecycle Hooks
  3. The Magic Docs Sub-Agent
  4. Dynamic Prompt Templating
  5. Context Isolation

Generated by Code IQ

Files in this section

01_magic_doc_identification.md
Chapter 1: Magic Doc Identification
Welcome to the MagicDocs project tutorial!
02_update_lifecycle_hooks.md
Chapter 2: Update Lifecycle Hooks
Welcome back! In the previous chapter, Magic Doc Identification, we learned how to mark a file as "Magic" using a speci…
03_the_magic_docs_sub_agent.md
Chapter 3: The Magic Docs Sub-Agent
Welcome to Chapter 3!
04_dynamic_prompt_templating.md
Chapter 4: Dynamic Prompt Templating
Welcome back!
05_context_isolation.md
Chapter 5: Context Isolation
Welcome to the final chapter of the MagicDocs tutorial!