65 lines
2.3 KiB
Markdown
65 lines
2.3 KiB
Markdown
# docs/ - Project Documentation
|
|
|
|
<!-- Parent: ../AGENTS.md -->
|
|
|
|
## OVERVIEW
|
|
|
|
Technical documentation, design plans, and implementation guides for the agent_park project.
|
|
|
|
## STRUCTURE
|
|
|
|
```
|
|
docs/
|
|
├── api-reference.md # API endpoint documentation
|
|
├── api-testing-guide.md # API testing instructions
|
|
├── discovery-workflow.md # Project discovery system docs
|
|
├── e2e-testing-guide.md # Playwright E2E guide
|
|
├── verification-report.md # Feature verification reports
|
|
├── analyst.md # Product analysis notes
|
|
├── n8n/ # n8n workflow documentation
|
|
│ ├── historical-workflow-design.md
|
|
│ ├── incremental-workflow-design.md
|
|
│ ├── tag-janitor-workflow.json
|
|
│ ├── project-tag-reset-workflow.json
|
|
│ ├── project-tag-reset-workflow.md
|
|
│ ├── github-link-janitor-workflow.json
|
|
│ ├── github-link-janitor-workflow.md
|
|
│ ├── github-link-repair-workflow.json
|
|
│ ├── github-link-repair-workflow.md
|
|
│ ├── github-stars-refresh-workflow.json
|
|
│ └── github-stars-refresh-workflow.md
|
|
└── plans/ # Design & implementation plans
|
|
├── 2026-01-25-ai-search-system-design.md
|
|
├── 2026-01-25-ai-search-implementation.md
|
|
├── 2025-01-25-ai-timeline-feature-design.md
|
|
├── 2025-01-25-ai-timeline-implementation.md
|
|
├── 2026-01-25-keyword-cloud-system-design.md
|
|
└── 2026-01-25-keyword-cloud-implementation.md
|
|
```
|
|
|
|
## KEY DOCUMENTS
|
|
|
|
| Document | Purpose |
|
|
|----------|---------|
|
|
| `api-reference.md` | Complete API documentation |
|
|
| `discovery-workflow.md` | Project discovery architecture |
|
|
| `plans/*.md` | Feature design & implementation specs |
|
|
| `n8n/*.md` | n8n workflow design docs |
|
|
| `n8n/project-tag-reset-workflow.json` | Project tag reset workflow (multi-AI category classification) |
|
|
|
|
## FOR AI AGENTS
|
|
|
|
### When Adding Documentation
|
|
|
|
1. Place design docs in `plans/` with date prefix
|
|
2. Update this AGENTS.md with new file entries
|
|
3. Follow existing markdown formatting
|
|
|
|
### Related Files
|
|
|
|
- `CLAUDE.md` - Main project context (root)
|
|
- `AGENTS.md` - Project knowledge base (root)
|
|
- `.claude/` - Custom agents & commands
|
|
|
|
<!-- MANUAL: Additional notes can be added below -->
|