Skip to content

README: Add deployed AWS architecture diagram#80

Merged
alanmaizon merged 1 commit intomainfrom
docs/readme-aws-architecture
Feb 18, 2026
Merged

README: Add deployed AWS architecture diagram#80
alanmaizon merged 1 commit intomainfrom
docs/readme-aws-architecture

Conversation

@alanmaizon
Copy link
Owner

@alanmaizon alanmaizon commented Feb 18, 2026

  • Replace the README Execution Status block with a Mermaid diagram of the deployed AWS architecture (CloudFront -> ALB -> ECS frontend/backend; backend -> RDS/S3/Bedrock).
  • Stop docs sync (scripts/sync_docs.py) from requiring/updating a README status block; tests updated accordingly.

Summary by Sourcery

Document the deployed AWS architecture in the README and stop treating the README as a synced status document.

Documentation:

  • Replace the README execution status section with a Mermaid diagram describing the deployed AWS architecture, including CloudFront, ALB, ECS services, RDS, S3, Secrets Manager, and Bedrock.

Tests:

  • Update sync_docs tests to no longer seed or assert on README status blocks, focusing checks on DEVELOPMENT_PLAN and AWS alignment docs.

Chores:

  • Remove README.md from the list of documentation files managed by scripts/sync_docs.py so its status block is no longer auto-generated or required.

@sourcery-ai
Copy link

sourcery-ai bot commented Feb 18, 2026

Reviewer's Guide

Replaces the README execution status section with a Mermaid-based AWS deployment architecture diagram and removes README from the docs sync pipeline so sync_docs.py and its tests now only manage the wiki-based status sections.

File-Level Changes

Change Details Files
Document the deployed AWS architecture in the README using a Mermaid diagram instead of an auto-generated execution status block.
  • Update stack description to distinguish local development storage from production storage and clarify Bedrock model usage.
  • Remove the auto-generated Execution Status section and its placeholder markers from the README.
  • Add a Mermaid flowchart diagram showing CloudFront -> ALB -> ECS Fargate services, backend dependencies on RDS/S3/Bedrock/Secrets Manager, and logging via CloudWatch.
README.md
Stop the docs sync script from reading/writing README status blocks and adjust tests to only track wiki docs freshness.
  • Remove README.md from the list of sync targets in the docs sync main routine so it no longer renders or updates README status content.
  • Adjust test repository seeding helper to no longer render or write README status markers.
  • Update stale-docs failure expectations to only reference the wiki documents (development plan and AWS alignment).
backend/tests/test_sync_docs.py
scripts/sync_docs.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • The list of sync targets (README/PLAN/AWS) is now partially duplicated between scripts/sync_docs.py and backend/tests/test_sync_docs.py; consider centralizing the targets in one place (or a small helper) so future changes don’t need to be kept in sync manually.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The list of sync targets (README/PLAN/AWS) is now partially duplicated between `scripts/sync_docs.py` and `backend/tests/test_sync_docs.py`; consider centralizing the targets in one place (or a small helper) so future changes don’t need to be kept in sync manually.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@alanmaizon alanmaizon merged commit 0b7330a into main Feb 18, 2026
12 checks passed
@alanmaizon alanmaizon deleted the docs/readme-aws-architecture branch February 18, 2026 17:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant