Updated README and did a little bit of cleanup

This commit is contained in:
2025-12-09 04:24:16 +01:00
parent 0c48640412
commit 6940c76e58
11 changed files with 1718 additions and 910 deletions

View File

@@ -23,7 +23,7 @@ agent_media/
└── infrastructure/ # External services & persistence
```
See [ARCHITECTURE_FINALE.md](ARCHITECTURE_FINALE.md) for details.
See [architecture_diagram.md](docs/architecture_diagram.md) for architectural details.
## Quick Start
@@ -223,8 +223,6 @@ poetry run mypy .
### Adding a New Tool
See [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) for detailed instructions.
Quick example:
```python
@@ -281,16 +279,6 @@ docker-compose logs -f
docker-compose down
```
## CI/CD
Includes Gitea Actions workflow for:
- ✅ Linting & testing
- 🐳 Docker image building
- 📦 Container registry push
- 🚀 Deployment (optional)
See [docs/CI_CD_GUIDE.md](docs/CI_CD_GUIDE.md) for setup instructions.
## API Documentation
### Endpoints
@@ -364,12 +352,12 @@ Clear session memories (STM + Episodic).
- Verify volume mounts in Docker
### Tests failing
- See [docs/TEST_FAILURES_SUMMARY.md](docs/TEST_FAILURES_SUMMARY.md)
- Run `poetry install` to ensure dependencies are up to date
- Check logs for specific error messages
## Contributing
Contributions are welcome! Please read [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) first.
Contributions are welcome!
### Development Workflow
@@ -384,11 +372,11 @@ Contributions are welcome! Please read [docs/CONTRIBUTING.md](docs/CONTRIBUTING.
## Documentation
- [Architecture](ARCHITECTURE_FINALE.md) - System architecture
- [Contributing Guide](docs/CONTRIBUTING.md) - How to contribute
- [CI/CD Guide](docs/CI_CD_GUIDE.md) - Pipeline setup
- [Flowcharts](docs/flowchart.md) - System flowcharts
- [Test Failures](docs/TEST_FAILURES_SUMMARY.md) - Known test issues
- [Architecture Diagram](docs/architecture_diagram.md) - System architecture overview
- [Class Diagram](docs/class_diagram.md) - Class structure and relationships
- [Component Diagram](docs/component_diagram.md) - Component interactions
- [Sequence Diagram](docs/sequence_diagram.md) - Sequence flows
- [Flowchart](docs/flowchart.md) - System flowcharts
## License