Skip to content

docs(readme): brand the header, drop mermaid for a static diagram - #13

Merged
GentBajko merged 1 commit into
mainfrom
docs/readme-brand
Sep 3, 2026
Merged

docs(readme): brand the header, drop mermaid for a static diagram#13
GentBajko merged 1 commit into
mainfrom
docs/readme-brand

Conversation

@GentBajko

@GentBajko GentBajko commented Sep 3, 2026

Copy link
Copy Markdown
Owner

Adds assets/: a keystone-arch mark, the wordmark outlined in Inter so it renders the same everywhere, and flow.svg in place of the mermaid fence. Each file carries a prefers-color-scheme block, so one asset covers light and dark; every shape also keeps a literal fill attribute as the fallback for renderers that strip the style.

The header is now logo, tagline, three metadata badges, and the Patreon and Buy Me a Coffee links. The nine-item numbered contents list collapses to a single row. Intro, diagram, and the two doc pointers are centered.

Mermaid went because GitHub hands it to a cross-origin iframe, which no wrapper in the README can position, and its stock palette fought the mark. docs/flows.md still uses it.

Summary by Sourcery

Refresh the README with branded assets and a static architecture diagram for a consistent presentation across renderers.

New Features:

  • Add branded logo, mark, and architecture flow assets with light and dark rendering support.
  • Add project metadata and supporter badges linking to Patreon and Buy Me a Coffee.

Enhancements:

  • Rework the README header and introduction into a centered branded layout with a compact navigation row.
  • Replace the README Mermaid diagram with a static SVG while retaining Mermaid diagrams in the flow documentation.

Documentation:

  • Improve README presentation with centered introductory content, architecture overview, navigation links, and documentation pointers.

Adds assets/: a keystone-arch mark, the wordmark outlined in Inter so
it renders the same everywhere, and flow.svg in place of the mermaid
fence. Each file carries a prefers-color-scheme block, so one asset
covers light and dark; every shape also keeps a literal fill
attribute as the fallback for renderers that strip the style.

The header is now logo, tagline, three metadata badges, and the
Patreon and Buy Me a Coffee links. The nine-item numbered contents
list collapses to a single row. Intro, diagram, and the two doc
pointers are centered.

Mermaid went because GitHub hands it to a cross-origin iframe, which
no wrapper in the README can position, and its stock palette fought
the mark. docs/flows.md still uses it.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Sorry @GentBajko, you've used your own review budget of 250,000 diff characters for the last 7 days.

You can request another review in 2 days by commenting @sourcery-ai review. Upgrade to get a review now.

@sourcery-ai

sourcery-ai Bot commented Sep 3, 2026

Copy link
Copy Markdown

Reviewer's Guide

The README opening is redesigned as a centered, branded header with metadata and support badges, while the Mermaid architecture diagram is replaced by theme-aware static SVG assets; Mermaid remains in docs/flows.md for detailed flow documentation.

File-Level Changes

Change Details Files
Replace the Mermaid README architecture diagram with static, theme-aware SVG assets.
  • Add flow.svg containing the README flow diagram.
  • Add light/dark logo and mark SVG variants with embedded prefers-color-scheme handling and literal fill fallbacks.
  • Keep Mermaid diagrams in docs/flows.md unchanged.
README.md
assets/flow.svg
assets/logo-dark.svg
assets/logo.svg
assets/mark-dark.svg
assets/mark.svg
Rework the README opening into a centered branded landing header.
  • Add the centered logo, tagline, compatibility/format/license badges, and support links.
  • Center the introductory copy, static diagram, contents navigation, and documentation links.
  • Collapse the numbered nine-item contents list into a single inline row while preserving section targets.
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

@GentBajko
GentBajko merged commit 0d09f5c into main Sep 3, 2026
1 check failed
@GentBajko
GentBajko deleted the docs/readme-brand branch September 3, 2026 23:18
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