README: one definition, one quickstart, inline demo video, lighter first screen - #807
Merged
Merged
Conversation
…rst screen - Rewrite README.md (and de, zh-CN, ja) around a single definition sentence, one quickstart, a 3-step how-it-works and a merged security section; the ERP and e-commerce tables are folded, the Claude/ChatGPT sections merged, the named competitor table replaced by a link to /vs, FAQ questions as H3 - Replace the 3.7 MB GIF with the full demo as a GitHub-hosted mp4 (9 MB, plays inline, poster as first frame); export-web.py now produces it - Write the README banners as 256-colour PNGs (~90 KB instead of ~320 KB) - Move community files to .github/ and ADOPTERS/AUTHORS/ROADMAP to docs/, video/demo to scripts/demo-video, so the README starts higher on the page - Fix the 7-vs-8 database engines contradiction and stale README anchors
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
The README had grown to 4,589 words (the median of 20 comparable repos is ~1,160) and said the same things several times: the quickstart twice, response mapping four times, the Knowledge Graph three times. Its 3.7 MB GIF loaded eagerly and repeated the banner's diagram, and 41 root entries pushed the README 2,086 px down the page.
README (en, de, zh-CN, ja)
export-web.pyproduces the mp4 instead.<details>, one security section, one section for Claude/ChatGPT/Copilot/Gemini, FAQ questions as H3.Assets and layout
.github/(GitHub still shows the tabs), ADOPTERS, AUTHORS and ROADMAP todocs/,video/demotoscripts/demo-video. CLA.md stays in the root because the CLA workflow and existing signatures link to it. Links, CODEOWNERS and .gitattributes updated; README anchors in docs fixed.adapter-count.mjs --checkexpectations updated for the rewritten translations..github/repo-about.txt) now leads with "self-hosted MCP gateway" and OpenAPI.