docs(readme): brand the header, drop mermaid for a static diagram - #13
Merged
Conversation
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.
There was a problem hiding this comment.
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.
Reviewer's GuideThe 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
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
Enhancements:
Documentation: