docs: 新增 AGENTS.md 专题页、安全边界说明和首页导览 || docs: Added AGENTS.md special page, security boundary description and home page navigation#1718
Conversation
新增页面： - docs/{zh,en}/customization/agents-md.md：AGENTS.md 专题页，说明
它与 README.md 的区别、加载行为（仅工作目录，大写优先）、/init 生成流程、推荐写入的内容以及何时需要更新 修改页面： - docs/{zh,en}/guides/interaction.md：在「审批与确认」后新增「安全 边界」章节，涵盖无沙箱运行环境、工作区范围、--add-dir / /add-dir 扩展目录、逐操作审批表、YOLO 模式风险和 MCP 工具风险边界 - docs/{zh,en}/index.md：首页新增文档导览，按四类场景引导读者（首次
使用、理解 Agent、配置模型与供应商、IDE/ACP/Wire/Print 模式集成）
- docs/{zh,en}/customization/agents.md：添加指向 agents-md.md 的
交叉链接
- docs/.vitepress/config.ts：为中英文侧边栏添加 agents-md 页面入口
github-actions
bot
changed the title
![chatgpt-codex-connector[bot]](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: a0c6357b62
ℹ️ 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".
|
|
||
| ### Workspace scope | ||
|
|
||
| The agent's file operations are centered around the working directory. Read-only tools like `ReadFile`, `Glob`, and `Grep` can access files within the working directory using relative paths, or read files outside it using absolute paths. `WriteFile` and `StrReplaceFile` work the same way, but all write and edit operations require user approval. |
There was a problem hiding this comment.
The new security-boundary text says ReadFile, Glob, and Grep can access files outside the working directory via absolute paths, but the implementation does not match that statement: Glob explicitly rejects directories outside work_dir/additional_dirs in _validate_directory (src/kimi_cli/tools/file/glob.py), while Grep does not enforce an absolute-path requirement in its call path (src/kimi_cli/tools/file/grep_local.py). This mismatch makes the boundary guidance inaccurate and can mislead users about what file access is actually possible.
Useful? React with 👍 / 👎.
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
| @@ -0,0 +1,95 @@ | |||
| # AGENTS.md project guide | |||
There was a problem hiding this comment.
🟡 English H1 title doesn't match sidebar label, violating naming convention
The H1 # AGENTS.md project guide in docs/en/customization/agents-md.md:1 uses sentence case, but the sidebar label defined in docs/.vitepress/config.ts:136 is AGENTS.md Project Guide (title case). The docs/AGENTS.md naming convention rule states: "Use consistent section labels that match the sidebar titles." Every other English page in the repo has its H1 matching the sidebar label exactly (e.g., # Agents and Subagents = sidebar Agents and Subagents, # Model Context Protocol = sidebar Model Context Protocol). This mismatch also causes inconsistent link text across pages: docs/en/customization/agents.md:5 uses [AGENTS.md project guide] (matching the H1), while docs/en/index.md:22 uses [AGENTS.md Project Guide] (matching the sidebar).
| # AGENTS.md project guide | |
| # AGENTS.md Project Guide |
Was this helpful? React with 👍 or 👎 to provide feedback.
1 participant
新增页面： - docs/{zh,en}/customization/agents-md.md：AGENTS.md 专题页，说明
它与 README.md 的区别、加载行为（仅工作目录，大写优先）、/init 生成流程、推荐写入的内容以及何时需要更新 修改页面： - docs/{zh,en}/guides/interaction.md：在「审批与确认」后新增「安全 边界」章节，涵盖无沙箱运行环境、工作区范围、--add-dir / /add-dir 扩展目录、逐操作审批表、YOLO 模式风险和 MCP 工具风险边界 - docs/{zh,en}/index.md：首页新增文档导览，按四类场景引导读者（首次
使用、理解 Agent、配置模型与供应商、IDE/ACP/Wire/Print 模式集成）
交叉链接
Related Issue
Resolve #(issue_number)
Description
Checklist
make gen-changelogto update the changelog.make gen-docsto update the user documentation.New page: - docs/{zh,en}/customization/agents-md.md: AGENTS.md topic page, description
Its difference from README.md, loading behavior (only working directory, uppercase first), /init generation process, recommended content and when it needs to be updated. Modified page: - docs/{zh,en}/guides/interaction.md: Added "Security Boundary" chapter after "Approval and Confirmation", covering sandbox-free operating environment, workspace scope, --add-dir / /add-dir extended directory, operation-by-operation approval table, YOLO Model Risk and MCP Tool Risk Boundary - docs/{zh,en}/index.md: New document navigation is added to the homepage to guide readers according to four types of scenarios (for the first time
Use and understand Agent, configuration model and supplier, IDE/ACP/Wire/Print mode integration)
cross link
Related Issue
Resolve #(issue_number)
Description
Checklist
make gen-changelogto update the changelog.make gen-docsto update the user documentation.