Skip to content

feat(docs): refresh bilingual README #478

Merged
phantom5099 merged 5 commits into1024XEngineer:mainfrom
Cai-Tang-www:feat/docs-readme-site-sync
Apr 27, 2026
Merged

feat(docs): refresh bilingual README #478
phantom5099 merged 5 commits into1024XEngineer:mainfrom
Cai-Tang-www:feat/docs-readme-site-sync

Conversation

@Cai-Tang-www
Copy link
Copy Markdown
Collaborator

@Cai-Tang-www Cai-Tang-www commented Apr 26, 2026

Summary

  • refresh README.md structure and navigation for current docs split
  • add README.en.md as the English counterpart
  • add README preview assets under docs/assert/readme/
  • add README entry links to both guide indexes (www/guide/index.md, www/en/guide/index.md)

Why

  • make repository entry points clearer for both Chinese and English readers
  • align repo README and docs-site guide navigation

Scope

Documentation and example only. No runtime/tool behavior changes.

Closes #477

@chatgpt-codex-connector
Copy link
Copy Markdown

Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits.
Credits must be used to enable repository wide code reviews.

Copy link
Copy Markdown

@fennoai fennoai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed the diff across code quality, performance, security, and documentation accuracy.

Key findings are focused on correctness and onboarding reliability in the new Gateway TypeScript example and README previews.

Comment thread examples/gateway-client/typescript/src/client.ts Outdated
Comment thread examples/gateway-client/typescript/src/client.ts Outdated
Comment thread examples/gateway-client/typescript/readme.md Outdated
Comment thread README.md Outdated
Comment thread README.en.md Outdated
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 26, 2026

Codecov Report

❌ Patch coverage is 88.33333% with 14 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
internal/skills/multi_loader.go 79.31% 7 Missing and 5 partials ⚠️
internal/tui/core/app/skills_commands.go 81.81% 2 Missing ⚠️

📢 Thoughts on this report? Let us know!

@Cai-Tang-www Cai-Tang-www changed the title feat(docs): refresh bilingual README and add gateway TS example feat(docs): refresh bilingual README Apr 26, 2026
@phantom5099
Copy link
Copy Markdown
Collaborator

还有在修改的吗

@Cai-Tang-www
Copy link
Copy Markdown
Collaborator Author

没了,应该就这样,先看看效果

@phantom5099 phantom5099 merged commit e04ff48 into 1024XEngineer:main Apr 27, 2026
3 checks passed
@Cai-Tang-www Cai-Tang-www deleted the feat/docs-readme-site-sync branch April 28, 2026 11:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: 更新双语 README 并补充 Gateway TypeScript 客户端示例

2 participants