Repository navigation
docs: align agent and user documentation with runtime behavior - #88
Merged
Merged
Conversation
4 of 7 tasks
codeasier
commented
Aug 8, 2026
codeasier
left a comment
Owner
Author
There was a problem hiding this comment.
跨模型 review 结果(DeepSeek / GLM / Kimi 独立审查 + 父会话复核)
用户文档中与运行时行为不符的事实性错误未通过复核。但新增 AGENTS.md 导航存在不完整/冲突问题。以下为经验证的行内发现,按严重度排序。
- 无用户文档事实性错误成立;
git diff --check与 AGENTS 严格校验(22 文件, 0 错误, 0 警告)均通过。 - 残余风险:尚无自动检查保障 EN/ZH 一致性及 AGENTS 导航完整性。
并行审查会增加 token 用量与成本。
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.
📝 Description
This PR now covers both repository-local agent guidance and a repository-wide user documentation governance pass.
Agent guidance
AGENTS.mdguidance for.github/,docs/,src/, andtests/subtrees.AGENTS.mdas the repository-wide navigation and invariant layer.User documentation
SnapshotAnalyzerAPI guides covering focus, device selection, template discovery, query execution, metadata, and errors.ResultMapperbehavior and the pass-throughdatetimedeclaration.🔗 Related Issues
Closes #91
Related: #90 tracks the no-op
leak_detection.device_idruntime template parameter; this documentation PR does not change query-template behavior.🧪 Testing
pytest tests/test_api.py tests/test_governance.py(27 passed)pytest tests/test_governance.py(14 passed)git diff --check✅ Checklist
Snapshot Runtime Provenance
Snapshot provenance decision: no-update
Snapshot provenance no-update reason: This PR changes documentation and AGENTS.md guidance only; it does not modify files under
src/pt_snap_cli/snapshot/other than the localAGENTS.mdinstruction file.📋 Additional Notes
The runtime metadata defect discovered during the documentation audit is intentionally tracked separately in #90 so it can be fixed with the query-template and CLI/MCP contract tests in scope.