docs(readme): iconic, professional README with visuals + Chinese docs - #15
Merged
Conversation
Rework the top-level README into a modern, visual landing page and add a Simplified Chinese translation. - Hand-authored inline SVGs: hero banner, architecture diagram, and a before/after performance chart (35s -> 0ms layout, 20-34x cheaper repaints). - A real graph.html render (10,708 nodes / 28,945 edges) as the 'what it produces' visual. - A lead 'Why CGraph?' value-add section: reverse-dependency/blast-radius, navigate-by-graph-not-grep, architecture-at-a-glance, deterministic + fast, built-for-agents. - Language support shown as brand-logo badges (C/C++/Go/Groovy/Java/JS/Kotlin/ Python/Ruby/Scala/TS/TSX). - README.md <-> README.zh-CN.md language switcher; badges (license, C++20, CMake, MCP, PRs). - Preserves the full install recipe (collapsible) and the MCP tools/registration reference. No code changes; docs + assets only.
Address review: the first pass dropped substantive reference content. Restore every original section and add a clickable table of contents so readers can jump to a specific section: - Restored: Repository layout, Output formats, Codex CLI + Cursor/Windsurf registration, CLI, Daemon & thin client, MCP server, Host integrations, Semantic enrichment, Development notes, full Prerequisites. - Added a Contents nav bar (anchor links) at the top of both languages. - Kept the visual additions (hero, architecture + performance SVGs, real graph render, language logo badges) and full English/Chinese parity. No information removed vs the original README; only reorganized + illustrated.
Keep the visual top prominent and scannable; tuck the heavy reference (full build recipe, per-agent registration, CLI/daemon/MCP, host integrations + enrichment) into <details> blocks. No content removed — everything is one click away, and the TOC still links each group.
Contributor
Author
Rendered previewHere's the new README as it renders (collapsibles closed, the way GitHub shows them by default) — the visual top stays scannable, and the dense reference (build recipe, per-agent registration, CLI/daemon/MCP, host integrations + enrichment) is one click away inside
Hero → Why CGraph? value table → Architecture diagram → the real 10,708-node graph → 35s→0ms performance chart → language logo badges → quick start, then folded reference. Bilingual ( |
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
2 participants
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.
Reworks the top-level README into a modern, visual landing page and adds a Simplified Chinese translation — the kind of README trending repos ship.
What changed (docs + assets only, no code)
graph.htmlviewer on a 10,708-node / 28,945-edge codebase.README.md⇄README.zh-CN.mdwith a language switcher; standard badges (license, C++20, CMake, MCP, PRs).Preview
Rendered locally (badges + SVGs resolve on GitHub):
Hero + value-add + architecture + the real graph + perf chart + language badges, all in one scroll. Assets are self-contained SVG/PNG under
assets/.Doc-only; nothing in the build or engine changes.