From 9545caaee13442d412b0fb742c2d541b283ce57a Mon Sep 17 00:00:00 2001 From: xgopilot Date: Sun, 26 Apr 2026 08:27:22 +0000 Subject: [PATCH] docs(www): remove stale /status command docs Generated with [codeagent](https://github.com/qbox/codeagent) Co-authored-by: Yumiue <188874804+Yumiue@users.noreply.github.com> --- www/en/guide/install.md | 18 +++++++++--------- www/en/guide/troubleshooting.md | 16 ++++++++-------- www/guide/install.md | 17 ++++++++--------- www/guide/troubleshooting.md | 12 ++++++------ 4 files changed, 31 insertions(+), 32 deletions(-) diff --git a/www/en/guide/install.md b/www/en/guide/install.md index 249dc281..c9ea34bb 100644 --- a/www/en/guide/install.md +++ b/www/en/guide/install.md @@ -36,7 +36,7 @@ go run ./cmd/neocode ## 3. Set API key -NeoCode reads API keys from environment variables — they are never written to config files. +NeoCode reads API keys from environment variables and never writes them to config files. macOS / Linux: @@ -66,9 +66,8 @@ Other providers: neocode ``` -You'll see the TUI interface. Type at the bottom to start a conversation. - -To specify a workspace: +You will enter the TUI. Type in the input box at the bottom to start a conversation. +To open a specific workspace: ```bash neocode --workdir /path/to/your/project @@ -76,7 +75,7 @@ neocode --workdir /path/to/your/project ## 5. First conversation -Not sure what to ask? Try these: +Need a starting prompt? Try: ```text Read the current project directory structure and give a module summary @@ -86,19 +85,20 @@ Read the current project directory structure and give a module summary Find the tool result injection logic in internal/runtime ``` -The agent will automatically use file reading and search tools. When it requests file writes or command execution, the TUI will prompt for your approval. +The agent will use file reading and search tools automatically. When it needs to write files or run commands, the TUI will ask for approval. -## 6. Command cheat sheet +## 6. Common `/` commands -Inside the TUI, type `/` commands to perform operations: +Inside the TUI, use `/` commands for common actions: | Command | Action | |---|---| | `/help` | Show all commands | | `/provider` | Switch provider | +| `/provider add` | Add a custom provider | | `/model` | Switch model | -| `/status` | Show current status | | `/compact` | Compress long session context | +| `/clear` | Clear the current draft | | `/cwd [path]` | View/switch workspace | | `/session` | Switch session | | `/memo` | View memory index | diff --git a/www/en/guide/troubleshooting.md b/www/en/guide/troubleshooting.md index ea53a3e8..97ae07f5 100644 --- a/www/en/guide/troubleshooting.md +++ b/www/en/guide/troubleshooting.md @@ -5,7 +5,7 @@ description: Common NeoCode issues and practical checks for startup, provider au # Troubleshooting -This page is organized as: symptom -> likely causes -> 3-step checks. +This page follows: symptom -> likely causes -> 3-step checks. ## 1) `neocode` command not found @@ -41,11 +41,11 @@ This page is organized as: symptom -> likely causes -> 3-step checks. 2. Check the env var mapping in [Configuration](./configuration). 3. Restart terminal, then launch `neocode` again. -## 3) Provider/model switch does not apply +## 3) Provider or model switch does not apply ### Symptom -- You switched provider/model but behavior still looks old. +- You switched provider or model, but behavior still looks unchanged. ### Likely causes @@ -54,8 +54,8 @@ This page is organized as: symptom -> likely causes -> 3-step checks. ### 3-step checks -1. Reconfirm with `/provider` and `/model`. -2. Run `/status` to inspect current session state. +1. Reconfirm the current selection with `/provider` and `/model`. +2. Run `/compact` to reduce stale context impact in the current session. 3. Start a new session and retry the same prompt. ## 4) Too many permission prompts @@ -89,9 +89,9 @@ This page is organized as: symptom -> likely causes -> 3-step checks. ### 3-step checks -1. Start `neocode gateway` separately and confirm it is healthy. +1. Start `neocode gateway` separately and confirm the process is running. 2. Verify minimal local path first on `127.0.0.1:8080`. -3. Review limits in [Gateway Usage](/guide/gateway). +3. Review auth and origin limits in [Gateway usage](./gateway). ## 6) Long sessions drift or degrade @@ -114,4 +114,4 @@ This page is organized as: symptom -> likely causes -> 3-step checks. - Return to [Getting Started](./) for a minimal path - Daily operations: [Daily use](./daily-use) -- Gateway issues: [Gateway usage](/guide/gateway) +- Gateway issues: [Gateway usage](./gateway) diff --git a/www/guide/install.md b/www/guide/install.md index 542c698e..a5ac2276 100644 --- a/www/guide/install.md +++ b/www/guide/install.md @@ -29,7 +29,7 @@ irm https://raw.githubusercontent.com/1024XEngineer/neo-code/main/scripts/instal ## 3. 设置 API Key -NeoCode 从环境变量读取 API Key,不会写入配置文件。 +NeoCode 只从环境变量读取 API Key,不会写入配置文件。 macOS / Linux: @@ -61,7 +61,7 @@ neocode 启动后你会看到 TUI 界面,底部是输入框,直接输入文字即可开始对话。 -如果想指定工作区: +如果要直接打开指定工作区: ```bash neocode --workdir /path/to/your/project @@ -69,7 +69,7 @@ neocode --workdir /path/to/your/project ## 5. 第一次对话 -不确定问什么?试试这两句: +不知道从哪里开始?可以先试这两句: ```text 请阅读当前项目目录结构,给出模块职责摘要 @@ -79,11 +79,11 @@ neocode --workdir /path/to/your/project 帮我在 internal/runtime 下定位与 tool result 回灌相关逻辑 ``` -Agent 会自动调用文件读取和搜索工具来完成任务。当它请求写入文件或执行命令时,TUI 会弹出权限确认——你确认后才执行。 +Agent 会自动调用文件读取和搜索工具。当它需要写入文件或执行命令时,TUI 会先弹出权限确认。 -## 6. 常用命令速查 +## 6. 常用 `/` 命令 -进入 TUI 后,输入 `/` 开头的命令可以执行操作: +进入 TUI 后,可用 `/` 命令执行常见操作: | 命令 | 作用 | |---|---| @@ -91,7 +91,6 @@ Agent 会自动调用文件读取和搜索工具来完成任务。当它请求 | `/provider` | 切换 Provider | | `/provider add` | 添加自定义 Provider | | `/model` | 切换模型 | -| `/status` | 查看当前状态 | | `/compact` | 压缩长会话上下文 | | `/clear` | 清空当前草稿 | | `/cwd [path]` | 查看/切换工作区 | @@ -102,13 +101,13 @@ Agent 会自动调用文件读取和搜索工具来完成任务。当它请求 | `/skills` | 查看可用 Skills | | `/exit` | 退出 | -## 装不上? +## 安装有问题? 看 [排障与常见问题](./troubleshooting) ## 开发者:从源码构建 -如果你需要阅读代码、调试功能或参与开发,可以从源码构建运行。需要 Go 1.25+ 环境。 +如果你要阅读代码、调试功能或参与开发,可以从源码构建运行。需要 Go 1.25+ 环境。 ```bash git clone https://github.com/1024XEngineer/neo-code.git diff --git a/www/guide/troubleshooting.md b/www/guide/troubleshooting.md index 806fb4f8..09c18714 100644 --- a/www/guide/troubleshooting.md +++ b/www/guide/troubleshooting.md @@ -5,7 +5,7 @@ description: NeoCode 首次使用和日常使用中的高频问题排查清单 # 排障与常见问题 -这页按“现象 -> 可能原因 -> 3 步排查”组织,优先解决首次使用中最常见的问题。 +这页按“现象 -> 可能原因 -> 3 步排查”组织,优先覆盖首次使用和日常使用中最常见的问题。 ## 1) 启动失败:`neocode` 命令不存在 @@ -41,11 +41,11 @@ description: NeoCode 首次使用和日常使用中的高频问题排查清单 2. 对照 [配置指南](./configuration) 的映射表,确认对应环境变量已设置。 3. 关闭并重新打开终端后再次启动 `neocode`。 -## 3) 切换 Provider / Model 后不生效 +## 3) 切换 Provider 或 Model 后不生效 ### 现象 -- 你已经切换了 Provider 或 Model,但请求仍像在走旧配置 +- 你已经切换了 Provider 或 Model,但行为看起来仍在使用旧配置 ### 可能原因 @@ -54,8 +54,8 @@ description: NeoCode 首次使用和日常使用中的高频问题排查清单 ### 3 步排查 -1. 在会话中执行 `/provider` 和 `/model` 再确认一次当前选择。 -2. 执行 `/status` 查看当前会话状态。 +1. 在会话中执行 `/provider` 和 `/model`,再确认一次当前选择。 +2. 执行 `/compact`,减少旧上下文对当前会话的影响。 3. 新建会话后重试同一个请求,确认是否恢复正常。 ## 4) 工具调用频繁被拦截或反复弹审批 @@ -91,7 +91,7 @@ description: NeoCode 首次使用和日常使用中的高频问题排查清单 ### 3 步排查 -1. 单独启动 `neocode gateway`,确认进程已正常运行。 +1. 单独启动 `neocode gateway`,确认进程已经正常运行。 2. 使用默认本地监听地址 `127.0.0.1:8080` 先验证最小链路。 3. 对照 [Gateway 与 URL Dispatch](./gateway) 检查鉴权与来源限制。