docs(readme): restructure README for easier onboarding - #1898
Merged
Conversation
Restructure all five language READMEs (EN/CN/JA/ES/KO) around getting started quickly instead of promotion: - Add a "What is Chat2DB" intro with core features and the 30+ supported databases, a clickable video cover linking to the intro video, and a 2x2 product screenshot grid - Move Quick Start up front with desktop and Docker paths side by side, including the git clone step required by the key init script - Condense the encryption key section to the essentials and fold the full configuration reference into a collapsible details block - Replace the three-edition comparison table with a short note linking to chat2db.ai - Remove promotional content: Nubase ad, Trendshift/ModelScope/X badges, Star History chart, Pro download placement, QR code - Switch clone URLs from SSH to HTTPS Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BnXg7Gt8C6npMjGBSSp8bG
Remove the "click to watch" caption under the video cover image and convert the Security Notes warning blockquote to plain paragraphs, keeping the section content unchanged, across all five language READMEs. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BnXg7Gt8C6npMjGBSSp8bG
Use the repo's icon.png (same mark as chat2db.ai) in place of the plain h1 text heading at the top of all five language READMEs. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BnXg7Gt8C6npMjGBSSp8bG
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.
Summary
Restructure all five language READMEs (EN / CN / JA / ES / KO) to focus on getting users started quickly, removing promotional content:
Removed
Improved onboarding
chat2db-community-plugins), clickable video cover linking to the intro video, and a 2x2 product screenshot gridgit clonestep required by the key init script<details>block — no technical content dropped./icon.png)All five language versions share the same structure (10 sections, 16 code fences, 1 details block) and were verified for consistency.
🤖 Generated with Claude Code
https://claude.ai/code/session_01BnXg7Gt8C6npMjGBSSp8bG