Repository navigation
docs: beautify README with SVG hero and section dividers - #44
Merged
Merged
Conversation
Restructure README following the beautify-github-readme approach: - Add SVG hero banner (assets/hero.svg) with logo, gradient title, tagline, and 4 stat cards — replaces the plain logo + h1 + badges - Add gradient section dividers (assets/section-divider.svg) between major sections for visual rhythm - Merge Features + Why FerrumKV into a single focused section to remove duplication - Reorder content proof-forward: Quick Start → Why → Dashboard → Eviction Policies → Benchmarks → Architecture → CLI → Contrib - Keep all body text searchable in Markdown; only the hero and dividers are SVGs Verified: cargo fmt --check, cargo clippy --all-targets -- -D warnings, cargo test --all-targets all green
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.
Summary
Restructure README following the beautify-github-readme approach — SVG hero, section dividers, proof-forward ordering, and reduced duplication.
What changed
assets/hero.svg: new — dark hero banner with logo, gradient title, tagline, and 4 stat cardsassets/section-divider.svg: new — gradient divider line between sections for visual rhythmREADME.md: merge Features + Why FerrumKV, move Quick Start to top, add dividers between sectionsWhy
The original README had content overlap between Features and Why FerrumKV, and the visual hierarchy was flat. The hero SVG creates a distinctive top anchor; the dividers add rhythm without sacrificing searchability.
Compatibility / risk
None. Docs-only change.
Verification
cargo fmt --check— cleancargo clippy --all-targets -- -D warnings— zero warningscargo test --all-targets— all green🤖 Generated with Claude Code