docs: enhance README with bilingual usage guide and directory details#17
Open
JiayuuWang wants to merge 1 commit intoChinaSiro:mainfrom
Open
docs: enhance README with bilingual usage guide and directory details#17JiayuuWang wants to merge 1 commit intoChinaSiro:mainfrom
JiayuuWang wants to merge 1 commit intoChinaSiro:mainfrom
Conversation
- Add English translations alongside existing Chinese content - Add How to Use section with prerequisites and step-by-step instructions for running extract-sources.js - Convert source metadata to a table for clarity - Expand directory structure with descriptions for all top-level folders including bridge, server, schemas, state, and components - Add Key Files table highlighting the most important entry points - Preserve all original Chinese content Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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
1 participant
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
extract-sources.jsbridge/,server/,schemas/,state/, andcomponents/directoriesMotivation
The current README is almost entirely in Chinese, which limits accessibility for international researchers and developers interested in studying Claude Code's architecture. Many visitors to this repo come from GitHub's global community and would benefit from English documentation.
Additionally, the README doesn't explain how to actually run
extract-sources.js— adding a clear usage section with prerequisites lowers the barrier for anyone who wants to reproduce the extraction themselves.Test plan
🤖 Generated with Claude Code