Repository navigation
docs: announce evolution to Kimi Code successor project - #2377
Conversation
Add a gentle migration notice across the README, VitePress home pages, and getting-started guides (zh + en), plus a dismissible site-top banner that points users to MoonshotAI/kimi-code. The banner sets VitePress's built-in --vp-layout-top-height so the navbar, sidebar, content, doc and hero offsets are handled by the default theme automatically.
There was a problem hiding this comment.
Pull request overview
This PR announces the transition from Kimi Code CLI to the successor Kimi Code project across the README and documentation site, while adding a dismissible localized VitePress banner.
Changes:
- Adds migration/evolution messaging to README and English/Chinese docs home/getting-started pages.
- Updates docs home CTA buttons to prefer the new Kimi Code repository while preserving links to existing CLI docs.
- Adds a custom VitePress theme banner with localized copy and localStorage-based dismissal.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds a prominent notice about the successor project and migration. |
| docs/zh/index.md | Updates Chinese home CTAs and adds successor-project messaging. |
| docs/zh/guides/getting-started.md | Adds a Chinese installation tip recommending Kimi Code. |
| docs/en/index.md | Updates English home CTAs and adds successor-project messaging. |
| docs/en/guides/getting-started.md | Adds an English installation tip recommending Kimi Code. |
| docs/.vitepress/theme/style.css | Adds layout offset styling for the new banner. |
| docs/.vitepress/theme/index.ts | Extends the VitePress layout to render the banner in the top slot. |
| docs/.vitepress/theme/EvolutionBanner.vue | Implements the dismissible localized evolution banner. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| } | ||
|
|
||
| onMounted(() => { | ||
| dismissed.value = localStorage.getItem(STORAGE_KEY) === '1' |
| ## 安装 | ||
|
|
||
|
|
||
| ::: tip 推荐前往新项目 |
| ::: tip Try the next-generation project | ||
| Kimi Code CLI is evolving into [Kimi Code](https://github.com/MoonshotAI/kimi-code). Installing Kimi Code **automatically migrates** your configuration and sessions. New users are encouraged to install Kimi Code directly; the instructions below still work, and existing users don't need to migrate immediately. |
|
|
||
|
|
||
| ::: tip 推荐前往新项目 | ||
| Kimi Code CLI 已升级为 [Kimi Code](https://github.com/MoonshotAI/kimi-code)，安装 Kimi Code 后会**自动迁移**你的配置与会话。新用户建议直接安装 Kimi Code； |
![chatgpt-codex-connector[bot]](/web-api/iframe-proxy?url=https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: a79439fa83
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| ## Installation | ||
|
|
||
| ::: tip Try the next-generation project |
There was a problem hiding this comment.
For files under docs/, docs/AGENTS.md says callout titles should be short category labels and that English callouts should use no title or a short label like Note; the new English title here is descriptive text, and the mirrored Chinese callout uses the same pattern instead of the prescribed 提示. This violates the documented docs convention and will keep the page inconsistent with the rest of the site, so move the descriptive wording into the body and use ::: tip/::: tip 提示.
Useful? React with 👍 / 👎.
docs/AGENTS.md requires short category labels (or no title) for ::: tip callouts. Drop the descriptive titles on the two getting-started tips so they match the rest of the site.
Summary
概述