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

* 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

web/backend/API/API.Core/Authentication/JwtAuthenticationHandler.cs

@@ -39,7 +39,6 @@ public class JwtAuthenticationHandler(
         if (string.IsNullOrWhiteSpace(secret))
             return AuthenticateResult.Fail("JWT secret is not configured");
 
-        // Check if Authorization header exists
         if (!Request.Headers.TryGetValue("Authorization", out StringValues authHeaderValue))
             return AuthenticateResult.Fail("Authorization header is missing");
 

web/backend/API/API.Core/Controllers/NotFoundController.cs

@@ -11,13 +11,13 @@ namespace API.Core.Controllers;
 /// </remarks>
 [ApiController]
 [ApiExplorerSettings(IgnoreApi = true)]
-[Route("error")] // required
+[Route("error")]
 public class NotFoundController : ControllerBase
 {
     /// <summary>
     ///     Returns a 404 response for any request that did not match a route.
     /// </summary>
-    [HttpGet("404")] //required
+    [HttpGet("404")]
     public IActionResult Handle404()
     {
         return NotFound(new { message = "Route not found." });

web/backend/API/API.Core/GlobalException.cs

@@ -1,5 +1,3 @@
-// API.Core/Filters/GlobalExceptionFilter.cs
-
 using Domain.Exceptions;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.Filters;

web/backend/API/API.Core/Program.cs

@@ -61,7 +61,6 @@ builder.Services.AddSwaggerGen(options =>
 });
 builder.Services.AddOpenApi();
 
-// Add FluentValidation
 builder.Services.AddValidatorsFromAssemblyContaining<Program>();
 builder.Services.AddValidatorsFromAssembly(typeof(BreweryController).Assembly);
 builder.Services.AddValidatorsFromAssembly(typeof(UserController).Assembly);
@@ -80,7 +79,6 @@ builder.Services.AddMediatR(cfg =>
     cfg.AddOpenBehavior(typeof(ValidationBehavior<,>));
 });
 
-// Add health checks
 builder.Services.AddHealthChecks();
 
 // Configure logging for container output
@@ -89,8 +87,6 @@ builder.Logging.AddConsole();
 if (!builder.Environment.IsProduction())
     builder.Logging.AddDebug();
 
-// Configure Dependency Injection -------------------------------------------------------------------------------------
-
 builder.Services.AddInfrastructureSql();
 
 builder.Services.AddFeaturesBreweries();
@@ -101,10 +97,8 @@ builder.Services.AddFeaturesEmails();
 // ITokenInfrastructure is registered here because JwtAuthenticationHandler depends on it directly.
 builder.Services.AddScoped<ITokenInfrastructure, JwtInfrastructure>();
 
-// Register the exception filter
 builder.Services.AddScoped<GlobalExceptionFilter>();
 
-// Configure JWT Authentication
 builder
     .Services.AddAuthentication("JWT")
     .AddScheme<JwtAuthenticationOptions, JwtAuthenticationHandler>("JWT", options => { });
@@ -128,7 +122,6 @@ app.MapHealthChecks("/health");
 app.MapControllers();
 app.MapFallbackToController("Handle404", "NotFound");
 
-// Graceful shutdown handling
 IHostApplicationLifetime lifetime = app.Services.GetRequiredService<IHostApplicationLifetime>();
 lifetime.ApplicationStopping.Register(() =>
 {