Repository navigation
docs: refine native agent guidance - #647
Conversation
gloryfromca
left a comment
There was a problem hiding this comment.
Blocking: preserve the old Raven-Code anchor, correct the Playbook label guidance, and replace the placeholder Claude trailer model ID.
I found two documentation defects inline. Separately, the commit ends with Co-authored-by: Claude (claude) ...; AGENTS.md section 3.3 requires the actual current-session model ID rather than a placeholder so per-model attribution remains distinguishable.
Coverage: I reviewed the repository rules in AGENTS.md/CLAUDE.md and the canonical agent terminology in CONTEXT-MAP.md/CONTEXT.md; the complete diff; the five launchers and manifests; ACP request handling; Worker Table, roster, DAG, Playbook, and instance behavior; the prior page state and relevant history; backward compatibility; and whether tests were weakened (no tests were changed). The implementation claims otherwise matched those sources.
Verification: uv run --frozen --group docs mkdocs build -f docs-site/mkdocs.yml --strict passed; uv run pytest tests/test_docs_site.py -x passed (16 tests); git diff --check github/main...HEAD passed. The built English and Chinese pages contain only the new Raven-Code anchor, confirming the old deep link is absent.
gloryfromca
left a comment
There was a problem hiding this comment.
Blocking: replace the original commit's placeholder Claude trailer with the actual model ID required by AGENTS.md.
The new commits fully address both inline findings, and I replied to and resolved those threads. No new documentation defect was found. The remaining blocker is unchanged in da2e7b77037c: Co-authored-by: Claude (claude) <noreply@anthropic.com> does not satisfy AGENTS.md section 3.3, which requires the actual current-session model ID rather than a placeholder.
Coverage: I re-read the complete github/main...HEAD diff and the delta from the prior revision; checked AGENTS.md/CLAUDE.md and the Worker Table, roster, DAG, and Playbook contracts in CONTEXT-MAP.md/CONTEXT.md; checked commit history, backward-compatible anchors, affected documentation links, and the prior review record. No tests were changed or weakened, and the architecture claims remain consistent with the runtime sources reviewed in the prior round.
Verification: uv run --frozen --group docs mkdocs build -f docs-site/mkdocs.yml --strict passed; both English and Chinese output contain the legacy and new Raven-Code anchors; uv run pytest tests/test_docs_site.py -x passed (16 tests); git diff --check github/main...HEAD passed.
191e26e to
9f81ee7
Compare
gloryfromca
left a comment
There was a problem hiding this comment.
No blockers; this can merge as far as I am concerned.
The rebase preserves all three reviewed patches byte-for-byte by stable patch ID, retains the Playbook-label correction and both bilingual Raven-Code anchors, and replaces the placeholder co-author trailer with a concrete model ID. Both threads I opened remain resolved. I found no new issue.
Coverage: I reviewed the complete github/main...HEAD diff, the rewritten commit history and patch identities, AGENTS.md/CLAUDE.md and the relevant CONTEXT terminology and architecture constraints, affected links and backward compatibility, the current review record, and whether tests were weakened (none were changed). The PR remains documentation-only despite the newer base.
Verification: git diff --check github/main...HEAD passed; uv run python scripts/check_commit_messages.py github/main..HEAD passed; uv run --frozen --group docs mkdocs build -f docs-site/mkdocs.yml --strict passed; both English and Chinese output contain the legacy and new Raven-Code anchors; uv run pytest tests/test_docs_site.py -x passed (16 tests).
|
The commit metadata finding is also fixed. After the authorized force-with-lease rewrite, the first commit now carries Co-authored-by: Codex (gpt-6-astra) noreply@openai.com. The two review-fix commits were replayed unchanged on top of the latest main. Range-diff and the full local documentation verification passed. |
Refine the native-agent documentation hierarchy, retain concise task templates, and move Raven-Code workspace and verification boundaries under the native-agent section. Update linked anchors in the builder guide. Co-authored-by: Codex (gpt-6-astra) <noreply@openai.com>
9f81ee7 to
ce6de72
Compare
gloryfromca
left a comment
There was a problem hiding this comment.
No blockers; this can merge as far as I am concerned.
This head is a base-only rebase. After refreshing github/main to the PR base, the change remains the same four-file documentation patch, and git range-diff reports all three reviewed commits unchanged. The resolved review threads remain settled, and I found no new issue.
Coverage: I checked the complete diff against the current target, rewritten history and range-diff, repository rules and relevant CONTEXT architecture terms, backward-compatible anchors and links, the review record, and test integrity. No tests were modified.
Verification: git diff --check github/main...HEAD passed; uv run python scripts/check_commit_messages.py github/main..HEAD passed; the strict bilingual MkDocs build passed; both legacy and canonical Raven-Code anchors render in English and Chinese; uv run pytest tests/test_docs_site.py -x passed (16 tests).
## Summary Refine the bilingual Agent Integrations documentation so the native-agent section is easier to scan. Keep the five-agent overview, calling paths, minimal ACP example, and concise task templates together. Move Raven-Code workspace and verification guidance under the native-agent section, keep both the new and legacy anchors, clarify that turn-local worker labels cannot be stored in Playbooks, and update the builder guide references. ## Type - [ ] Fix - [ ] Feature - [x] Docs - [ ] CI / tooling - [ ] Refactor - [ ] Other ## Verification - [x] Relevant tests pass locally - [ ] Relevant lint / type checks pass locally - [x] User-facing docs or screenshots are updated when needed Commands and results: ```text PYTHONDONTWRITEBYTECODE=1 TMPDIR=/root/tmp uv run --frozen --group docs mkdocs build -f docs-site/mkdocs.yml --strict --site-dir /root/tmp/raven-docs-site-fix Passed: bilingual strict build. PYTHONDONTWRITEBYTECODE=1 TMPDIR=/root/tmp uv run --frozen --group docs pytest -p no:cacheprovider tests/test_docs_site.py tests/test_living_docs.py tests/integration/test_docs_site_controls_e2e.py -q -o addopts='' Passed: 77 tests. git diff --check origin/main...HEAD Passed. uv run python scripts/check_commit_messages.py origin/main..HEAD Passed. make check-large-files Passed. ``` ## Risk - [x] Security impact considered - [x] Backward compatibility considered - [x] Rollback path is clear for risky changes This is a documentation-only change. The existing Raven-Code deep link is preserved, and reverting the commit restores the previous documentation structure. ## Related Issues N/A --------- Co-authored-by: userName20260323 <270284818+userName20260323@users.noreply.github.com> Co-authored-by: Codex (gpt-6-astra) <noreply@openai.com>
Summary
Refine the bilingual Agent Integrations documentation so the native-agent section is easier to scan. Keep the five-agent overview, calling paths, minimal ACP example, and concise task templates together. Move Raven-Code workspace and verification guidance under the native-agent section, keep both the new and legacy anchors, clarify that turn-local worker labels cannot be stored in Playbooks, and update the builder guide references.
Type
Verification
Commands and results:
Risk
This is a documentation-only change. The existing Raven-Code deep link is preserved, and reverting the commit restores the previous documentation structure.
Related Issues
N/A