31 lines
1.3 KiB
Smarty
31 lines
1.3 KiB
Smarty
# {{PROJECT_NAME}} — AI Document Index & Context
|
|
|
|
> **Target**: AI Agents
|
|
> **Writing Style**: ASD-STE100 Simplified Technical English (`ste-writing`). Brief, terse, active voice.
|
|
|
|
## 📚 Document Catalog (Inject Specific Document)
|
|
Read this index to inject the exact file you need. Do not search all files.
|
|
|
|
| Document Title | Path | Scope / Description |
|
|
| :--- | :--- | :--- |
|
|
| **System Overview** | `docs/outline/01-system-overview.md` | Explains project purpose, main architecture, and active services. |
|
|
| **Configuration & Env** | `docs/outline/02-config-and-env.md` | Lists environment variables, config paths, network ports, and secrets. |
|
|
| **Code Structure Map** | `docs/outline/03-code-map.md` | Shows folder structure, core entry points, and primary dependencies. |
|
|
| **AI Agent Runbook** | `docs/outline/04-agent-runbook.md` | Gives step-by-step commands to build, test, and restart agent work. |
|
|
|
|
---
|
|
|
|
## 🎯 System Summary
|
|
{{SYSTEM_INTENT_STE_TERSE}}
|
|
|
|
## ⚙️ Core Configuration
|
|
- **Env File**: `{{ENV_FILE_PATH}}`
|
|
- **Config Directory**: `{{CONFIG_DIR_PATH}}`
|
|
- **Active Ports**: `{{ACTIVE_PORTS}}`
|
|
|
|
## 🔄 Agent Restart Steps
|
|
1. Read the Document Catalog above. Inject only required files.
|
|
2. Check git status: `git status`.
|
|
3. Check recent commits: `git log -n 5 --oneline`.
|
|
4. Run validation test: `{{VALIDATION_COMMAND}}`.
|