Skip to content

docs: improve goals.md formatting and clarity (zh/en)#435

Closed
wenhua020201-arch wants to merge 3 commits into
MoonshotAI:mainfrom
wenhua020201-arch:docs/optimize-0.10.0
Closed

docs: improve goals.md formatting and clarity (zh/en)#435
wenhua020201-arch wants to merge 3 commits into
MoonshotAI:mainfrom
wenhua020201-arch:docs/optimize-0.10.0

Conversation

@wenhua020201-arch
Copy link
Copy Markdown
Contributor

@wenhua020201-arch wenhua020201-arch commented Jun 4, 2026

Summary

Polish the goals.md page (zh + en) added in 0.10.0 for readability and formatting consistency.

  • Merge duplicate opening paragraphs — the original had two paragraphs saying the same thing in different words; merged into one with a dash-introduced example list
  • Colon before code examples — sentences introducing code blocks now end with :\ instead of .`
  • Bold state names in lifecycle listcomplete / paused / blocked rendered as **name** for visual scanability
  • Keyboard shortcut table — replaced the prose run-on sentence listing all shortcuts with a two-column table (key / action)
  • Remove draft background text (EN) — the "Queue upcoming goals" section opened with 4 lines of product-requirements context that don't belong in user docs; removed
  • zh/en parity maintained throughout

Files changed

  • docs/zh/guides/goals.md
  • docs/en/guides/goals.md

wenhua020201-arch and others added 3 commits June 3, 2026 15:08
…ks (#1)

* docs(zh): content improvements across multiple pages

- 最新动态:去掉 GitHub 链接,用用户视角重写每条功能说明
- 环境变量:简化开头,核心路径补充 KIMI_DISABLE_TELEMETRY 和 KIMI_MODEL_*,供应商凭证表格去掉冗余「用途」列
- 官方插件(datasource):重命名页面和侧边栏,安装拆成 4 步含验证,数据能力按类介绍,简化案例,去掉卸载节
- 链接文本:interaction.md 和 mcp.md 中带锚点链接去掉重复的节名说明

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* docs(zh): rewrite whats-new with feature-first style

每条功能回归「功能名:陈述+顺带说价值」格式,去掉前置用户视角标题,
删除开头 GitHub Releases 链接。

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Co-authored-by: moonshot <moonshot@moonshotdeMacBook-Pro.local>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
- Merge redundant opening paragraphs into one with concrete examples
- Use colons before code examples (not periods)
- Bold state names in lifecycle list (complete/paused/blocked)
- Replace prose keyboard shortcut description with table
- Remove draft product-background text from EN queue section
- zh/en parity maintained throughout

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Jun 4, 2026

⚠️ No Changeset found

Latest commit: d77ca3c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented Jun 4, 2026

pnpm dlx https://pkg.pr.new/@moonshot-ai/kimi-code@d77ca3c
npx https://pkg.pr.new/@moonshot-ai/kimi-code@d77ca3c

commit: d77ca3c

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: d77ca3cde1

ℹ️ About Codex in GitHub

Codex has been enabled to automatically 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 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread config.mts
@@ -0,0 +1,87 @@
import { defineAdditionalConfig } from "vitepress";

export default defineAdditionalConfig({
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Move added docs into the deployed docs tree

When the docs deploy workflow runs, it builds only with pnpm -C docs run build and uploads docs/.vitepress/dist, so VitePress reads docs/.vitepress/config.ts and pages under docs/, not this repository-root config or the new root-level zh/... pages. As a result, the sidebar links introduced here and the five new Chinese pages are never included in the published docs; place them under docs/zh and wire them through docs/.vitepress/config.ts, or update the build workflow to use this root config.

Useful? React with 👍 / 👎.

Comment on lines +28 to +30
已激活的 [Agent Skills](./customization/skills.md) 会自动注册为斜杠命令,以 `/skill:<name>` 调用;若 Skill 名称与内置命令不冲突,也可以省略 `skill:` 前缀直接输入 `/<name>`。

部分命令仅在 Agent 空闲时可用,流式输出或上下文压缩期间需先按 `Esc` 中断。`/yolo`、`/plan`、`/help` 等始终可用。全部命令说明见[斜杠命令参考](./reference/slash-commands.md)。
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Point new docs links at existing pages

If this new docs tree is served, or after it is moved under the deployed docs tree, these relative links resolve to files that are not present (for example zh/kimi-code-cli/customization/skills.md and zh/kimi-code-cli/reference/slash-commands.md; I checked the added zh/ tree). Users following the newly added Interaction page will hit 404s for core follow-up docs, so either add the missing pages in this tree or update the links to the existing docs/zh/... slugs.

Useful? React with 👍 / 👎.

Comment on lines +9 to +12
1. 在 Kimi Code CLI 内运行 `/plugin`
2. 在弹出的菜单中选择 **Marketplace**
3. 找到 **Kimi Datasource**,选择安装
4. 安装完成后运行 `/new` 开启新会话,再次运行 `/plugin` 确认插件状态为已安装
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Use the actual plugins slash command

This installation path tells users to run /plugin, but the TUI registers only the plural plugins command and its registry entry has no aliases, so following these steps opens no plugin manager and blocks installation of Kimi Datasource. The surrounding product docs and command dispatcher both use /plugins; update both occurrences here to the plural command.

Useful? React with 👍 / 👎.

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.

1 participant