Skip to content

docs: reorganize README and add bilingual SDK guides - #62

Merged
TheNorthStarYang merged 1 commit into
AhakeyAI:mainfrom
ZephyrKeXiner:docs/readme
Sep 10, 2026
Merged

TheNorthStarYang merged 1 commit into
AhakeyAI:mainfrom
ZephyrKeXiner:docs/readme

Conversation

@ZephyrKeXiner

Copy link
Copy Markdown
Member

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.md and docs/zh/overview.md, with a separate Chinese README under docs/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:

  • Checked 154 local links and anchors across all 10 changed documents; git diff --check passed.
  • npm run typecheck and npm test passed in sdks/typescript (2 SDK tests).
  • Built and installed a local SDK archive, compiled all three documented TypeScript examples, and exercised initialization, host calls, valid/invalid greeting input, three simulated lever states, notifications, shutdown, and exit through an isolated JSON-RPC harness.
  • Confirmed that the English and Chinese guides use matching code examples.

@ZephyrKeXiner ZephyrKeXiner self-assigned this Sep 8, 2026
@ZephyrKeXiner
ZephyrKeXiner marked this pull request as draft September 9, 2026 13:19
@ZephyrKeXiner
ZephyrKeXiner marked this pull request as ready for review September 10, 2026 02:30
@TheNorthStarYang
TheNorthStarYang merged commit 931ebef into AhakeyAI:main Sep 10, 2026
2 checks passed
@ZephyrKeXiner
ZephyrKeXiner deleted the docs/readme branch September 10, 2026 11:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants