Repository navigation
docs: v1.6.0 文档对齐与质量治理更新 - #2
Merged
Merged
Conversation
Co-authored-by: traeagent <traeagent@users.noreply.github.com>
Co-authored-by: traeagent <traeagent@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR updates the project’s documentation to align with the v1.6.0 TypeScript+ESM architecture and the default Ink TUI experience, while adding “drift warnings” to outdated examples and introducing a v1.7 quality/features roadmap spec.
Changes:
- Rewrite/realign core docs (README CN/EN, CLAUDE.md) to reflect the v1.6.0 architecture, CLI flags, slash commands, toolset, and directories.
- Add explicit drift warnings across
examples/so readers don’t assume legacy CommonJS / removed APIs still run. - Add a v1.7 roadmap spec document and update
CHANGELOG.md; normalizerelease.ymlline endings.
Reviewed changes
Copilot reviewed 11 out of 13 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Chinese README rewritten for v1.6.0 architecture, CLI usage, tools, commands, and ecosystem modules |
| README.en.md | English README rewritten to match v1.6.0 architecture and usage |
| CLAUDE.md | Developer guide updated for TypeScript+ESM + Ink TUI and refreshed module map |
| CHANGELOG.md | Adds v1.6.0 release notes and reflows older sections |
| examples/batch/README.md | Adds drift warning clarifying current batch-mode behavior |
| examples/hub-minimal.js | Adds drift warning noting src/hub removal and migration guidance |
| examples/hub-usage.js | Adds drift warning noting src/hub removal and migration guidance |
| examples/memory/README.md | Adds drift warning describing the new memory subsystem shape/location |
| examples/plugins/README.md | Adds drift warning about ESM migration and new hook lifecycle events/types |
| examples/workflows/README.md | Adds drift warning about createTeamRuntime removal and swarm migration |
| docs/superpowers/specs/2026-08-21-v1.7-quality-and-features-spec.md | Adds v1.7 engineering hardening + roadmap spec |
| .github/workflows/release.yml | LF normalization only (no content changes intended) |
Suppressed comments (6)
README.md:394
file.readis documented as supporting offset/limit pagination, but the tool schema only supportsmaxBytestruncation (src/tools/registry.ts). This can mislead users about how to page large files.
| `file.read` | 读取工作区内文本文件（支持 offset/limit 分页） | 路径限制在工作区根目录内 |
README.md:399
file.searchis documented as having case options and ReDoS protection, but the current implementation always builds a JS RegExp withgiand has no dedicated ReDoS guard (src/tools/registry.ts). The table should avoid claiming protections/options that do not exist.
| `file.search` | 在文本文件中搜索内容（支持正则/大小写配置） | 支持 ReDoS 防护 |
README.en.md:401
web.fetchis documented as doing URL validation, but the tool currently callsfetch(url)directly without validation (src/tools/registry.ts). The README should not claim URL validation if it is not implemented.
| `web.fetch` | Fetch a URL as plain text | URL validation |
README.md:401
web.fetchis documented as doing URL validation, but the tool currently callsfetch(url)directly without validation (src/tools/registry.ts). The README should not claim URL validation if it is not implemented.
| `web.fetch` | 获取网页内容并转为纯文本 | URL 校验 |
README.en.md:394
file.readis documented as offset/limit pagination, but the tool only supportsmaxBytestruncation (src/tools/registry.ts). This can mislead users about how to page large files.
| `file.read` | Read a workspace text file (offset/limit pagination) | Path confined to workspace root |
README.en.md:399
file.searchis documented as having case options and ReDoS protection, but the current implementation always uses a JS RegExp withgiand has no dedicated ReDoS guard (src/tools/registry.ts). The table should avoid claiming protections/options that do not exist.
| `file.search` | Search file contents (regex/case options) | ReDoS protection |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| ## 本地工具 | ||
|
|
||
| Agent Shell 内置一个受限制的工具注册表，所有文件操作均限定在工作区根目录内，防止路径穿越攻击。 | ||
| Agent 内置一个受限制的工具注册表，所有文件操作均限定在工作区根目录内，防止路径穿越攻击。 |
| | `shell.run` | Execute local commands | Permission prompt decides in non-yolo mode | | ||
| | `web.fetch` | Fetch web pages and convert to plain text | URL fetching | | ||
| | `web.search` | Search the web for information | Requires search API config | | ||
| The agent has a restricted tool registry; all file operations are confined to the workspace root to prevent path traversal attacks. |
| * programmatic entry point is now the package root `src/index.ts` (default | ||
| * export with `engine`, `tools`, `api`, `config`, `skills`, `memory`, | ||
| * `commands`, `swarm`, … namespaces). The repo is also ESM + TypeScript now, | ||
| * so migrate to `import hax from "hax-agent"` style code. |
| * programmatic entry point is now the package root `src/index.ts` (default | ||
| * export with `engine`, `tools`, `api`, `config`, `skills`, `memory`, | ||
| * `commands`, `swarm`, … namespaces). The repo is also ESM + TypeScript now, | ||
| * so migrate to `import hax from "hax-agent"` style code. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🎯 Changes
1. 文档全面重写与更新
--legacy回退等新界面说明。--sandbox标志，修复 Anthropic 工具名含点号导致工具调用失败的问题。2. 示例文档漂移警告与更新
src/cli.ts，更新快速开始示例。src/hub已移除，示例需迁移到src/index.ts包入口的 ESM 导入方式。~/.haxagent/memories/下的 Markdown 文件 + MEMORY.md 索引，旧自由函数 API 已被MemoryStore类取代。require()失效，camelCase钩子名已替换为 10 个生命周期事件。createTeamRuntime模块已不存在，多 Agent 协作迁移至src/swarm/。3. 新增文档与文件
index.html的二进制共享包文件。4. 其他改进
💡 Technical Highlights
index.html的二进制共享包，可能为桌面应用集成或特定渲染需求提供便利。release.yml的换行符为 LF，提升跨平台协作的一致性。