Open
Conversation
- Document the data model and end-to-end alert flow at the top, with a link to CONTRIBUTING.md for the full breakdown. - Split Quick Tour into a user path (docker compose pull/up against the published image, no Poetry needed) and a contributor path (make run, which builds locally and requires Poetry). - Fix the docs URL: 8080 -> 5050 to match docker-compose.yml. - Drop the outdated Swagger screenshot from the v0.1.2 release. - Remove the dead Heroku redoc badge (also fixes its brain=main typo). - Reframe the Contributing section to highlight that CONTRIBUTING.md also covers data model, codebase tour and developer setup.
github-actions
Bot
added
the
topic: docs
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #580 +/- ##
=======================================
Coverage 88.75% 88.75%
=======================================
Files 52 52
Lines 2196 2196
=======================================
Hits 1949 1949
Misses 247 247
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #422.
Summary
CONTRIBUTING.mdfor the full breakdown.docker compose pull && docker compose up, no Poetry needed) and a contributor path (make run, builds locally, requires Poetry).localhost:8080->localhost:5050to matchdocker-compose.yml.brain=maintypo).CONTRIBUTING.mdalso documents data model, codebase tour and developer setup, not just contribution guidelines.Test plan
cp .env.example .env && docker compose pull && docker compose up) and confirmhttp://localhost:5050/docsloads the Swagger UI.make run) and confirm it succeeds, thenmake stop.