Refactor comments and update documentation for backend and pipeline (#246)

Browse Source

* Remove restating comments in backend

* Remove restating comments in frontend stories

* Remove restating comments in pipeline

* Remove restating comments in pipeline scripts

* Restore location-clear comment in BreweryRepository

* Remove stale/restating comments found in second pass

* Restore mock curated-data branch comment in main.cc

* Remove more restating/filler comments in backend

* Document account-management endpoints, compose files, and env generator

* Squashed commit of the following:

commit a8a5b8abd9969859c695092fae6990d03b2135ed
Author: Aaron Po <aaron.po97@gmail.com>
Date:   Sun Aug 23 23:53:56 2026 -0400

    Add reverse geocoding for brewery street addresses (#245)

    * Add geocoding to seed application, remove postal codes from generator

    Update comments

* Update pipeline class diagram for OpenAI generator

* Update pipeline activity diagram for brewery coordinates and OpenAI backend

* Add mailpit, production, db-only, and minimal environments to deployment diagram

* Fix authentication flow diagram for Identity migration

* Add account-management flows to authentication diagram

* Fix database schema diagram note referencing removed AuthRepository

...

This commit is contained in:

Aaron Po

2026-08-24 01:05:42 -04:00

committed by Aaron Po

parent cd5fd2d998

commit c825d99b0a

46 changed files with 1037 additions and 218 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download Patch File Download Diff File Expand all files Collapse all files

2

docs/website/diagrams-out/authentication-flow.svg

File diff suppressed because one or more lines are too long

2

docs/website/diagrams-out/database-schema.svg

File diff suppressed because one or more lines are too long

2

docs/website/diagrams-out/deployment.svg

File diff suppressed because one or more lines are too long