Update harness docs#1404
Merged
Merged
Conversation
oss-maintainer
approved these changes
May 15, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation update for the Harness framework: rewrites and expands the Chinese Harness docs, adds English versions of the Harness pages (architecture, workspace, filesystem, memory, session, subagent, tool, sandbox, quickstart, examples, overview, blog), wires them into _toc.yml, and switches Mermaid diagrams to client-side rendering via sphinxcontrib-mermaid plus a custom zoom-modal script. Also retunes the landing page hero (HarnessAgent-first messaging and links).
Changes:
- Add English Harness docs (architecture/workspace/filesystem/memory/session/subagent/tool/sandbox/quickstart/examples/overview/blog) and register them in
_toc.yml. - Migrate Mermaid blocks from
```mermaidto```{mermaid}(MyST directive) and addsphinxcontrib-mermaiddep +mermaid_version: "11"config; shipmermaid-zoom.jsfor click-to-zoom. - Rework
intro.md(EN/ZH) hero copy, default to HarnessAgent tab, point CTA atharness/overview.html, replace ASCII multi-agent diagram, and shorten the Maven install snippet toio.agentscope:agentscope-harness.
Reviewed changes
Copilot reviewed 27 out of 27 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/_config.yml | Enable sphinxcontrib.mermaid, set Mermaid v11, register mermaid-zoom.js. |
| docs/_toc.yml | Add EN Harness pages (architecture/workspace/.../sandbox/examples) to the sidebar. |
| docs/pyproject.toml | Add sphinxcontrib-mermaid>=0.9.2 to dev extras. |
| docs/_static/custom.css | Home-page header layout tweaks. |
| docs/_static/mermaid-zoom.js | New: hover button + modal for zooming Mermaid SVGs. |
| docs/zh/intro.md | Hero copy and CTA changes; HarnessAgent default tab; new ASCII multi-agent diagram. |
| docs/zh/harness/{architecture,subagent}.md | Major rewrite/restructure of architecture and subagent docs. |
| docs/zh/harness/{workspace,tool,session,memory,filesystem}.md | Switch Mermaid fences to MyST {mermaid} directive. |
| docs/en/intro.md | Parallel EN updates to hero/tabs/diagram/CTA. |
| docs/en/harness/{overview,architecture,workspace,filesystem,memory,session,subagent,tool}.md | New full English Harness pages. |
| docs/en/harness/sandbox/index.md | New English Sandbox page. |
| docs/en/harness/{quickstart,example}/index.md | New stub pages linking to other docs. |
| docs/en/blogs/{index,agentscope-v1-harness}.md | Promote blog stub to full English release article. |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
No description provided.