docs(1.7.x): clarify install-agent vs Job, reorganize examples/ (#925)#926
Merged
Conversation
Restructure 1.7.x docs (EN+ZH) to present install-agent and Job as two parallel agent-usage capabilities. Reorganize examples/ by capability so readers can find the right entry point. Docs: - Getting Started/rock-agent.md: Job-first, install-agent second. 1.1 Prepare yaml lists one Harbor (Terminal Bench) and one Bash (claw-eval) template — point to the canonical *.yaml.template files instead of inlining a fabricated example. - References/rock-agent.md: title -> "Install Agent in Sandbox (Experimental)"; reframe RockAgent as ROCK's mechanism for installing custom agents in a sandbox; positioning blurb makes clear that install-agent and Job use distinct config schemas (do not mix). - References/job.md (NEW): "Use Job to Run Agent" with end-to-end SDK example. The agents: field is documented as Harbor's own minimal schema (name, model_name) — not RockAgentConfig. - ZH run() flow numbering bug fixed. - Soften deprecation note on rock.sdk.bench.Job to "future release". Examples: - agents/ -> install-agents/ - harbor/ -> job/harbor/ - bash/ + evaluation/claw_eval/ -> job/bash/ - evaluation/swe_bench/ kept in place - READMEs added for install-agents/, job/, job/bash/, job/harbor/, evaluation/ - Fix REAMDE.md typo, drop __pycache__/ - Update inline path references in moved files Refs #925 Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
BCeZn
changed the title
zhongwen666
pushed a commit
to zhongwen666/ROCK
that referenced
this pull request
May 17, 2026
…aba#926) Restructure 1.7.x docs (EN+ZH) to present install-agent and Job as two parallel agent-usage capabilities. Reorganize examples/ by capability so readers can find the right entry point. Docs: - Getting Started/rock-agent.md: Job-first, install-agent second. 1.1 Prepare yaml lists one Harbor (Terminal Bench) and one Bash (claw-eval) template — point to the canonical *.yaml.template files instead of inlining a fabricated example. - References/rock-agent.md: title -> "Install Agent in Sandbox (Experimental)"; reframe RockAgent as ROCK's mechanism for installing custom agents in a sandbox; positioning blurb makes clear that install-agent and Job use distinct config schemas (do not mix). - References/job.md (NEW): "Use Job to Run Agent" with end-to-end SDK example. The agents: field is documented as Harbor's own minimal schema (name, model_name) — not RockAgentConfig. - ZH run() flow numbering bug fixed. - Soften deprecation note on rock.sdk.bench.Job to "future release". Examples: - agents/ -> install-agents/ - harbor/ -> job/harbor/ - bash/ + evaluation/claw_eval/ -> job/bash/ - evaluation/swe_bench/ kept in place - READMEs added for install-agents/, job/, job/bash/, job/harbor/, evaluation/ - Fix REAMDE.md typo, drop __pycache__/ - Update inline path references in moved files Refs alibaba#925 Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
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
2 participants
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.
Summary
Restructure 1.7.x docs (EN+ZH) and
examples/so the two agent-usage capabilities ROCK provides — install-agent and Job — are presented as parallel options with clear cross-references, instead of the current ambiguous "Rock Agent" naming.sandbox.agent.install()+sandbox.agent.run(prompt)— install/run an agent inside a single sandbox.rock.sdk.job.Job+JobConfig(BashJob / HarborJob) — schedule tasks across a sandbox cluster.Changes
Docs (EN + ZH, 1.7.x only)
Getting Started/rock-agent.mdrewritten — Job is the primary scenario, install-agent is the secondary path.References/Python SDK References/rock-agent.md— H1 retitled to Install Agent in Sandbox (Experimental) with a positioning blurb; ZHrun()flow numbering bug fixed; usage example expanded to a runnable demo.References/Python SDK References/job.md(new) — Use Job to Run Agent with end-to-end Python SDK example and a cross-link to RockAgentConfig.examples/
agents/→install-agents/harbor/→job/harbor/bash/+evaluation/claw_eval/→job/bash/evaluation/swe_bench/kept in place (install-agent-style end-to-end demo)install-agents/,job/,job/bash/,job/harbor/,evaluation/REAMDE.md→README.mdtypo, removed stale__pycache__/.pyfilesOlder versions (1.1.x – 1.6.x) are intentionally not touched.
Test plan
npm run startandnpm run start -- --locale zh-HansinOpenSource/docs/, switch to 1.7.x:grep -r "examples/agents\|examples/harbor\b\|examples/bash\b\|examples/evaluation/claw_eval"in 1.7.x docs returns 0 matchesexamples/install-agents/iflow_cli/iflow_cli_demo.pyruns end-to-endexamples/job/harbor/harbor_demo.py -c examples/job/harbor/swe_job_config.yamlruns end-to-endfixes #925
🤖 Generated with Claude Code