Skip to content

docs(152): Update README with project status and guides #244

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Antonyjin merged 4 commits into from
Oct 31, 2025
Merged

docs(152): Update README with project status and guides #244

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4ecf650
docs(152): Add links to new deployment and architecture documentation
Jouzep Oct 31, 2025
edb10cc
docs(152): Add PROJECT_ROADMAP.md with project phases and timeline
Jouzep Oct 31, 2025
f5fb981
docs(152): Add 3_WEEK_SPRINT.md with detailed sprint plan
Jouzep Oct 31, 2025
497dcdd
rm: not neede docs
Antonyjin Oct 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -571,3 +571,19 @@ BACKEND=python python -m python_app.app

**Need help?** Start with the [Wiki Home](https://github.com/Antonyjin/Legacy-Project/wiki), check [CI Workflow Guide](docs/CI_WORKFLOW_GUIDE.md), or ask in Issues! 🚀

---

## 📚 Additional Documentation

### Deployment & Operations
- **[Deployment Guide](docs/DEPLOYMENT_GUIDE.md)** - Complete guide for local, Docker, and production deployment
- **[CI/CD Guide](docs/CI_CD_GUIDE.md)** - How the CI/CD pipeline works and how to debug issues

### Architecture & Technical Decisions
The following architectural decision records document all major decisions made during the project:

- **[ADR-004: Migration Strategy](docs/adr/ADR-004-migration-strategy.md)** - Phased, test-driven approach with black-box testing
- **[ADR-005: Testing Approach](docs/adr/ADR-005-testing-approach.md)** - Four-tier testing strategy (unit, integration, golden, smoke)
- **[ADR-006: Deployment Platform](docs/adr/ADR-006-deployment-platform.md)** - Docker on VPS with docker-compose
- **[ADR-007: CI/CD Pipeline](docs/adr/ADR-007-cicd-pipeline.md)** - GitHub Actions-based automation

Loading