Skip to content

README: Fix Mermaid parse error in edge labels#82

Merged
alanmaizon merged 1 commit intomainfrom
fix/readme-mermaid-parse-2
Feb 18, 2026
Merged

README: Fix Mermaid parse error in edge labels#82
alanmaizon merged 1 commit intomainfrom
fix/readme-mermaid-parse-2

Conversation

@alanmaizon
Copy link
Owner

@alanmaizon alanmaizon commented Feb 18, 2026

Some Mermaid renderers choke on parentheses/special chars in edge labels. This simplifies the two edge labels that were causing parse errors.

Summary by Sourcery

Documentation:

  • Simplify Mermaid edge labels in the README flowchart to be compatible with more Mermaid renderers.

@sourcery-ai
Copy link

sourcery-ai bot commented Feb 18, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates README Mermaid diagram edge labels to avoid parse errors in some Mermaid renderers by simplifying problematic label text.

Flow diagram for updated README Mermaid edge labels

flowchart TB
  ALB -->|/*| FE
  ALB -->|/api/*| BE

  FE -->|fetch /api same origin| CF

  BE -->|SQL over TLS| RDS[(RDS Postgres)]
  BE -->|Objects| S3[S3 Uploads Bucket]
  BE -->|Secrets injection| SM[Secrets Manager<br/>DATABASE_URL]
  BE -->|LLM + Embeddings| BR[Amazon Bedrock<br/>Nova + Titan]
Loading

File-Level Changes

Change Details Files
Simplified Mermaid flowchart edge labels in the README to remove characters that cause parse issues.
  • Updated frontend-to-cloud function edge label from including a parenthesized note about same-origin fetch to a simpler 'fetch /api same origin' text.
  • Updated backend-to-database edge label from 'SQL (TLS)' to 'SQL over TLS' to avoid parentheses in the label.
README.md

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 reviewed your changes and they look great!


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 ee83a86 into main Feb 18, 2026
12 checks passed
@alanmaizon alanmaizon deleted the fix/readme-mermaid-parse-2 branch February 18, 2026 17:45
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