Skip to content

CHORE: Make Readme more concise and reference docs - #145

Merged
mberz merged 2 commits into
devfrom
chore/update_readme_compact
Sep 2, 2026
Merged

CHORE: Make Readme more concise and reference docs#145
mberz merged 2 commits into
devfrom
chore/update_readme_compact

Conversation

@mberz

@mberz mberz commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

This pull request significantly refactors and updates the README.md to provide a clearer, more concise overview of the CHORAS backend. The new README improves project documentation, highlights CI/CD and documentation status, and streamlines setup and contribution guidelines.

Documentation and Project Overview:

  • Added CI/CD and documentation status badges at the top for better project visibility.
  • Simplified and clarified the project description, focusing on core responsibilities and integration requirements.

Technology Stack and Features:

  • Updated and reorganized the technology stack section for clarity, combining related items and correcting naming conventions (e.g., Flask-SQLAlchemy, Flask-Migrate).
  • Explicitly listed Celery as the job queue system.

Setup and Contribution:

  • Removed outdated environment setup, deployment, and command instructions, instead directing users to the documentation pages for setup and to the contributing guide for community involvement.

@mberz
mberz merged commit a77db2f into dev Sep 2, 2026
8 checks passed
@github-project-automation github-project-automation Bot moved this from Backlog to Done in CHORAS planning Sep 2, 2026
@mberz
mberz deleted the chore/update_readme_compact branch September 2, 2026 16:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant