Files
The-transit-Project/monitoring_ui/docs/README.md
T
Sven laptop 635a130f0b
Build and Push Docker Images / detect-changes (push) Successful in 11s
Build and Push Docker Images / build-auth-api (push) Successful in 1m0s
Build and Push Docker Images / build-employee-api (push) Successful in 1m2s
Build and Push Docker Images / build-transit-api (push) Successful in 1m1s
Build and Push Docker Images / build-error-log-api (push) Successful in 1m5s
Build and Push Docker Images / build-admin-ui (push) Successful in 1m13s
Build and Push Docker Images / build-monitoring-ui (push) Successful in 1m15s
Build and Push Docker Images / deploy-test-node (push) Successful in 3s
──────
### Summary of Changes
  1. Documentation Consolidation:
      • Relocated the docs/ folder and all repository .md files (README.md, DEPLOYMENT.md, DOCKER_README.md,
      DOMAINS_README.md, GETTING_STARTED.md, CI_CD_PORTAINER_GUIDE.md, ADMIN_DEPLOYMENT_SUMMARY.md,
      SECURITY_PRIVATE_FILES.md, handoff.md, azure-project-plan.md, plus service-specific READMEs) into .
      • Updated document links in README.md.
  2. AI Agent Project Map:
      • Created PROJECT_MAP.md in the project root containing complete architecture diagrams, service specs, ports, DB
      schemas, environment variables, and developer workflows.
      • Added PROJECT_MAP.md to .gitignore.
  3. Monitoring UI & Infrastructure Integration:
      • Added monitoring_ui service to docker-compose.yml (port 5175).
      • Configured Gitea workflow docker-build.yml for monitoring_ui builds.
      • Added CORS middleware headers in index.js.
      • Added nginx.conf copy step in Dockerfile.

  ──────
  ### Recommended Commit Message

    docs: consolidate project documentation into monitoring_ui and add agent project map

    - Move all markdown documentation files and docs/ folder into monitoring_ui/docs/
    - Update documentation hub index (monitoring_ui/docs/README.md) with relative paths
    - Generate comprehensive AI agent reference map (PROJECT_MAP.md) in repository root
    - Add PROJECT_MAP.md and monitoring_ui build output/env overrides to .gitignore
    - Integrate monitoring_ui service into docker-compose.yml and Gitea CI workflow
    - Configure CORS handling in employee_api for monitoring dashboard access
    ──────
  ### Alternative Short Commit Message

    refactor(docs): move docs to monitoring_ui and create AI agent PROJECT_MAP.md
2026-09-20 23:33:55 +02:00

30 lines
1.8 KiB
Markdown

# Transit Project Documentation Hub
This directory is the consolidated documentation hub for the Transit Project. All system documentation, operational guides, and service specifications live here inside `monitoring_ui/docs/`.
## Core Guides
- [Project Guide](PROJECT_GUIDE.md): Architecture, local development, environment variables, Docker, deployment, database prerequisites, and troubleshooting.
- [Monitoring UI Guide](MONITORING_UI.md): Complete operations manual for `monitoring_ui`.
- [Root Readme](ROOT_README.md): Original main overview page.
- [Getting Started Guide](GETTING_STARTED.md): 5-minute setup & deployment quickstart.
- [Deployment Guide](DEPLOYMENT.md): Production deployment instructions & DB setup.
- [CI/CD & Portainer Guide](CI_CD_PORTAINER_GUIDE.md): Automation, registry, and Portainer stack deployment.
- [Admin Deployment Summary](ADMIN_DEPLOYMENT_SUMMARY.md): Deployment status and deliverable notes.
- [Docker Notes](DOCKER_README.md): Docker and Docker Compose workflows.
- [Domains Overview](DOMAINS_README.md): Domain mappings and endpoint list.
- [Security & Private Files](SECURITY_PRIVATE_FILES.md): Security practices & credential safety rules.
- [Developer Handoff](handoff.md): Engineering handoff notes.
- [Azure Project Plan](azure-project-plan.md): Azure migration and project planning notes.
## Service Documentation
- [Admin UI Documentation](admin_ui/README.md)
- [Admin Schedule API Guide](admin_ui/SCHEDULE_API.md)
- [Enhanced Schedule Maker](admin_ui/SCHEDULE_MAKER_ENHANCED.md)
- [Transit API Documentation](transit_api/README.md)
- [Local Bus Timetable Spec](transit_api/LOCAL_BUS_TIMETABLE_README.md)
- [Windows XP Driver UI Documentation](windows_xp_driver_ui/README.md)
- [Deprecated Flutter Client Documentation](deprecated/README.md)