Skip to content

Conversation

@coolert
Copy link
Owner

@coolert coolert commented Dec 7, 2025

PR Summary

This PR improves the engineering documentation by updating the CI/CD section in the README and introducing a dedicated Deployment Guide.


Changes

README

  • Added CI/CD Pipeline Diagram under the CI/CD section
  • Added a concise Deployment (Overview) section following CI/CD for better structure and clarity

Documentation

  • Added new file: docs/deployment.md
  • Includes a clean, production-ready deployment flow description
  • Documents GitHub Actions deploy workflow, server-side deploy script, Supervisor worker, Cron scheduling, and permissions

Type of Change

  • Feature
  • Fix
  • Docs
  • Refactor
  • CI
  • Other

@coolert coolert merged commit 85091de into main Dec 7, 2025
2 checks passed
@coolert coolert deleted the docs/add-ci-cd-diagram-and-deployment-guide branch December 9, 2025 12:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant