-
Notifications
You must be signed in to change notification settings - Fork 24
Visualize system architecture, document CI/CD pipeline, and define database schema #6
Copy link
Copy link
Open
Description
Description
The current README.md for StudyBuddy lists its features and installation steps but lacks technical depth regarding the cloud architecture and internal data relationships.
To lower the barrier for new contributors, we need to move from text descriptions to high-fidelity diagrams that explain how the application is containerized, deployed, and how data flows between users and study rooms.
Proposed Tasks
- Architecture Diagram: Create a Mermaid.js diagram illustrating the tech stack flow:
GitHub Repo->GitHub Actions->Docker Hub->Azure App Service. - ER Diagram (Database Schema): Add a visual representation of the Django models. This should show the relationships between
User,Room,Topic, andMessage. - CI/CD Workflow Documentation: Create a new file
docs/DEPLOYMENT.mdexplaining the GitHub Actions workflow. Document the necessary secrets (Azure Credentials, Docker Login) required to fork and deploy the project. - Environment Configuration Guide: Expand the installation section to include a
template.envor a list of required Django settings (SECRET_KEY, DEBUG, ALLOWED_HOSTS).
Reasoning
- Onboarding: New developers can't easily see how a "Message" is linked to a "Room" without digging into
models.py. An ER diagram makes this instant. - DevOps Transparency: Since the project highlights "CI/CD" and "Azure," documenting the how is just as important as stating that it's there.
- Contribution Quality: Clearer architectural docs lead to fewer broken PRs regarding database migrations or deployment configurations.
Labels
documentation enhancement good-first-issue ECWOC'26
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels