docs: consolidate and clean up documentation

- Remove redundant files: AGENTS.md, INSTRUCTIONS.yaml, instructions.mdc
- Create comprehensive CONTRIBUTING.md with all development guidelines
- Add simple documentation index at docs/README.md
- Update main README to reference consolidated docs
- Remove implementation notes and release summaries
- Keep only essential, current documentation
This commit is contained in:
William Valentin
2025-09-14 19:29:21 -07:00
parent 302a3d545c
commit 3fd7b1ca53
6 changed files with 555 additions and 179 deletions

25
docs/README.md Normal file
View File

@@ -0,0 +1,25 @@
# UnitForge Documentation
## 📚 Documentation
| Document | Description |
|----------|-------------|
| [**Main README**](../README.md) | Project overview, installation, and usage |
| [**Contributing Guide**](../CONTRIBUTING.md) | Development setup and workflow |
| [**Environment Configuration**](ENVIRONMENT.md) | Environment variable reference |
| [**Docker Setup**](../docker/README.md) | Container development |
| [**Scripts & Utilities**](../scripts/README.md) | Development tools |
## 🚀 Quick Start
**New users**: Start with the [Main README](../README.md)
**Contributors**: Follow the [Contributing Guide](../CONTRIBUTING.md)
**Configuration**: See [Environment Variables](ENVIRONMENT.md)
## 🔗 External References
- [systemd documentation](https://systemd.io/)
- [FastAPI documentation](https://fastapi.tiangolo.com/)
- [uv documentation](https://github.com/astral-sh/uv)