Skip to content

docs(www): 重构文档站并补齐 MCP 与 Skills 指南#468

Merged
phantom5099 merged 4 commits into1024XEngineer:mainfrom
Yumiue:codex/docs-mcp-skills
Apr 26, 2026
Merged

docs(www): 重构文档站并补齐 MCP 与 Skills 指南#468
phantom5099 merged 4 commits into1024XEngineer:mainfrom
Yumiue:codex/docs-mcp-skills

Conversation

@Yumiue
Copy link
Copy Markdown
Collaborator

@Yumiue Yumiue commented Apr 26, 2026

背景

补齐网站文档中 MCP 与 Skills 的用户指南,并同步此前的 GitHub Pages 简洁风文档站重构结果。

更改

  • 新增中英文 MCP 工具接入指南,覆盖 stdio 配置、工具命名、暴露策略、验证和排障。
  • 新增中英文 Skills 使用指南,说明 SKILL.md 写法、启停命令、会话限制和与记忆/MCP 的区别。
  • 重组 www 文档入口与侧边栏,收敛旧 docs 目录到 guide 结构。
  • 更新首页与全局主题为更简洁的文档站风格。

验证

  • pnpm docs:build
  • 本地预览确认 /neo-code/guide/mcp/neo-code/guide/skills/neo-code/en/guide/mcp/neo-code/en/guide/skills 可访问。
  • 检查新增与修改的关键文档文件为 UTF-8 无 BOM。

@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.

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 26, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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.

Thanks for the docs refresh and IA cleanup. I found a few noteworthy issues:

  1. www/guide/install.md and www/en/guide/install.md
  • /status is documented, but this command is removed in current TUI implementation (internal/tui/core/app/commands_test.go asserts /status should error).
  1. www/guide/troubleshooting.md and www/en/guide/troubleshooting.md
  • Troubleshooting instructs users to run /status, which no longer exists.
  1. www/guide/tools-permissions.md and www/en/guide/tools-permissions.md
  • The statement "read-only operations run automatically" and row webfetch | No are inaccurate: current policy can require approval for webfetch on non-whitelisted domains.
  • Full Access shortcut is documented as !, but current keymap uses Ctrl+F.
  1. www/.vitepress/theme/components/HomeLanding.vue
  • Security hardening: for external links with target="_blank", use rel="noopener noreferrer" (currently only noreferrer).


1. Reconfirm with `/provider` and `/model`.
2. Run `/status` to inspect current session state.
3. Start a new session and retry the same prompt.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

/status is referenced here, but the command has been removed in current TUI behavior. This likely sends users to a non-existent command during troubleshooting.

@Yumiue
Copy link
Copy Markdown
Collaborator Author

Yumiue commented Apr 26, 2026

/simplify

@fennoai
Copy link
Copy Markdown

fennoai Bot commented Apr 26, 2026

Done

Implemented and simplified the actionable unresolved review item(s) from the comment log.

What I changed

  • Fixed stale /status references (command removed in current TUI).
  • Updated troubleshooting guidance to use valid flow (/compact + new session retry).
  • Synced command cheat sheets in install docs so only current commands are listed.
  • Applied wording simplification/alignment in both Chinese and English docs via code-simplifier.

Changed files:

  • www/en/guide/troubleshooting.md
  • www/guide/troubleshooting.md
  • www/en/guide/install.md
  • www/guide/install.md

Validation

  • Tried pnpm docs:build (failed: pnpm not installed in runner).
  • Tried corepack pnpm docs:build (failed: corepack not installed).

Git

View job run

Generated with [codeagent](https://github.com/qbox/codeagent)
Co-authored-by: Yumiue <188874804+Yumiue@users.noreply.github.com>
Comment thread www/guide/gateway.md
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

这个文档看看需不需要留下

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

网关是给高端用户选择的,里面主要是一种启动方式的

docs(www): remove stale /status command docs
Copy link
Copy Markdown
Collaborator

@phantom5099 phantom5099 left a comment

Choose a reason for hiding this comment

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

一样看看要不要留“不合适”描述

Comment thread www/guide/index.md
| 习惯在终端里工作 | ✅ 非常适合 |
| 需要完全本地运行,数据不出本机 | ✅ 非常适合 |
| 想要可扩展的 AI 助手,而不是固定功能的 SaaS | ✅ 非常适合 |
| 只用过 ChatGPT 网页版,不熟悉命令行 | ⚠️ 需要适应终端交互 |
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

一样看看要不要留“不合适”描述

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

留着,也算是用户筛选

@phantom5099 phantom5099 merged commit 33675e3 into 1024XEngineer:main Apr 26, 2026
3 checks passed
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.

3 participants