docs: reorganize README and add bilingual SDK guides - #62
Merged
Merged
Conversation
ZephyrKeXiner
marked this pull request as draft
September 9, 2026 13:19
ZephyrKeXiner
marked this pull request as ready for review
September 10, 2026 02:30
TheNorthStarYang
approved these changes
Sep 10, 2026
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.
The root README now provides a concise project introduction and links to the detailed overview, installation instructions, SDK guides, and contribution guide. The original project details are preserved in
docs/overview.mdanddocs/zh/overview.md, with a separate Chinese README underdocs/zh/.Adds Star History and contributor sections, bilingual contribution guidelines, and complete TypeScript plugin SDK documentation covering local installation, a working plugin tutorial, manifests, permissions, lifecycle, host APIs, Swift host integration, examples, and troubleshooting. Language links and relative paths are updated throughout.
Validation:
git diff --checkpassed.npm run typecheckandnpm testpassed insdks/typescript(2 SDK tests).