141 lines
4.0 KiB
Markdown
141 lines
4.0 KiB
Markdown
# Documentation Index
|
|
|
|
**AI Stack Deployer** - Technical documentation and implementation guides.
|
|
|
|
---
|
|
|
|
## 📋 Documentation Rules
|
|
|
|
### File Organization
|
|
- **Root Level** (`/`): User-facing docs only (README.md, CLAUDE.md, ROADMAP.md)
|
|
- **docs/** folder: All technical documentation, guides, and reports
|
|
- **docs/archive/**: Historical/deprecated documentation
|
|
|
|
### Naming Conventions
|
|
- `UPPERCASE_WITH_UNDERSCORES.md` for formal documentation
|
|
- Use descriptive names: `FEATURE_NAME_GUIDE.md` or `COMPONENT_STATUS.md`
|
|
- Date-stamped reports: Include generation date in file header
|
|
|
|
### Document Structure
|
|
All technical docs must include:
|
|
1. **Title** with brief description
|
|
2. **Last Updated** date
|
|
3. **Status** (Draft, In Progress, Complete, Deprecated)
|
|
4. **Table of Contents** (if > 100 lines)
|
|
5. **Clear sections** with headers
|
|
|
|
### Maintenance
|
|
- Update dates when editing
|
|
- Mark outdated docs as **Deprecated** (move to archive/)
|
|
- Cross-reference related docs
|
|
- Keep README.md (this file) up to date
|
|
|
|
---
|
|
|
|
## 📚 Documentation Inventory
|
|
|
|
### Status Reports (Generated)
|
|
| File | Description | Last Updated |
|
|
|------|-------------|--------------|
|
|
| [LOCALE_STATUS_REPORT.md](./LOCALE_STATUS_REPORT.md) | i18n implementation status & progress | 2026-01-13 |
|
|
| [ROADMAP_SUMMARY.md](./ROADMAP_SUMMARY.md) | Roadmap with priorities and timeline | 2026-01-13 |
|
|
| [TESTING.md](./TESTING.md) | Test results and QA status | 2026-01-13 |
|
|
|
|
### Implementation Guides
|
|
| File | Description | Purpose |
|
|
|------|-------------|---------|
|
|
| [AGENTS.md](./AGENTS.md) | Agent instructions for AI assistants | Implementation guidelines |
|
|
| [DOKPLOY_DEPLOYMENT.md](./DOKPLOY_DEPLOYMENT.md) | Dokploy API integration guide | Deployment orchestration |
|
|
| [DEPLOYMENT_STRATEGY.md](./DEPLOYMENT_STRATEGY.md) | Overall deployment architecture | System design |
|
|
| [SHARED_PROJECT_DEPLOYMENT.md](./SHARED_PROJECT_DEPLOYMENT.md) | Shared project configuration | Dokploy setup |
|
|
|
|
### System Design
|
|
| File | Description | Purpose |
|
|
|------|-------------|---------|
|
|
| [PRODUCTION_API_SPEC.md](./PRODUCTION_API_SPEC.md) | REST API specification | API reference |
|
|
| [LOGGING-PLAN.md](./LOGGING-PLAN.md) | Monitoring & logging architecture | Observability |
|
|
| [MCP_SERVER_GUIDE.md](./MCP_SERVER_GUIDE.md) | MCP server implementation | Claude integration |
|
|
|
|
### Troubleshooting
|
|
| File | Description | Purpose |
|
|
|------|-------------|---------|
|
|
| [DOCKER_BUILD_FIX.md](./DOCKER_BUILD_FIX.md) | Docker build issues & solutions | Build troubleshooting |
|
|
|
|
---
|
|
|
|
## 🗂️ Quick Reference
|
|
|
|
### For Users
|
|
- Start here: [Main README](../README.md)
|
|
- Roadmap: [ROADMAP.md](../ROADMAP.md)
|
|
- Setup: [CLAUDE.md](../CLAUDE.md)
|
|
|
|
### For Developers
|
|
- Implementation: [AGENTS.md](./AGENTS.md)
|
|
- API Docs: [PRODUCTION_API_SPEC.md](./PRODUCTION_API_SPEC.md)
|
|
- Deployment: [DOKPLOY_DEPLOYMENT.md](./DOKPLOY_DEPLOYMENT.md)
|
|
|
|
### For Operations
|
|
- Monitoring: [LOGGING-PLAN.md](./LOGGING-PLAN.md)
|
|
- Troubleshooting: [DOCKER_BUILD_FIX.md](./DOCKER_BUILD_FIX.md)
|
|
- Testing: [TESTING.md](./TESTING.md)
|
|
|
|
---
|
|
|
|
## 📝 Creating New Documentation
|
|
|
|
### Template
|
|
```markdown
|
|
# [Document Title]
|
|
|
|
**Last Updated**: YYYY-MM-DD
|
|
**Status**: [Draft|In Progress|Complete|Deprecated]
|
|
**Author**: [Name]
|
|
|
|
---
|
|
|
|
## Overview
|
|
Brief description of what this document covers.
|
|
|
|
## [Main Sections]
|
|
...
|
|
|
|
## Related Documentation
|
|
- Link to related docs
|
|
- Cross-references
|
|
|
|
---
|
|
|
|
**Generated/Updated By**: [Name/Tool]
|
|
**Review Date**: YYYY-MM-DD
|
|
```
|
|
|
|
### Checklist
|
|
- [ ] Title clearly describes content
|
|
- [ ] Date stamps included
|
|
- [ ] Status indicator present
|
|
- [ ] Sections well-organized
|
|
- [ ] Cross-references added
|
|
- [ ] Added to this README.md index
|
|
|
|
---
|
|
|
|
## 🔄 Update Workflow
|
|
|
|
1. **Create/Edit** documentation in `docs/`
|
|
2. **Update** this README.md index
|
|
3. **Commit** with descriptive message: `docs: add/update [FILENAME]`
|
|
4. **Review** outdated docs quarterly
|
|
5. **Archive** deprecated docs to `docs/archive/`
|
|
|
|
---
|
|
|
|
## 📂 Archive
|
|
|
|
See [docs/archive/](./archive/) for historical documentation.
|
|
|
|
---
|
|
|
|
**Last Updated**: 2026-01-13
|
|
**Maintained By**: Project maintainers
|