Skip to content

docs: correct stale layout text and complete the directory map - #559

Merged
Dong1017 merged 3 commits into
mainfrom
impl/layout-docs
Nov 21, 2026
Merged

Dong1017 merged 3 commits into
mainfrom
impl/layout-docs

Conversation

@Dong1017

@Dong1017 Dong1017 commented Nov 21, 2026 •

Copy link
Copy Markdown
Collaborator

Governing Issue and delivery slice

Refs #498
Refs #558

Knowledge authorship declaration

No path protected by docs/knowledge-model-policy.md changes. The declaration below is disclosure only.

{"schema_version":1,"head_sha":"caf2517c65f662b16e680023d028e14881357cb3","human_only":false,"material_ai_authors":[{"tool":"Claude Code","model_id":"claude-opus-5-5","effort":"xhigh","role":"author"}]}

Changed artifacts and evidence

File Change Check
docs/module-layout.md 3 stale Infra sentences RETIRED_MODULES in tests/_gate_policy_support.py:103 is the two package names
docs/architecture.md map completed; one table row every added path exists on main 7a7ab84; descriptions come from module docstrings
docs/contributing.md model guidance harness/scenarios/external.py:1: "independent of model and device"
3 __init__.py docstrings text only none of the three files is in _runtime_identity() or the skill-eval controller hashes

Checks and dependencies

  • Checks actually run (result and tested scope): ruff on the three changed Python files passes; git diff --check is clean. Locally on Windows, tests/test_architecture_closed_loop.py, tests/test_target_module_import_gate.py, tests/test_package_root_inventory.py and tests/test_template_layout.py, filtered to layout, doc, root and template tests: 46 passed. The tests that read module-layout.md look for phrases this PR keeps.
  • Failed, skipped, timed-out or not-run checks (if applicable): test_template_layout.py::test_maintained_documentation_links_resolve fails locally because this checkout is sparse and has no evidence/ tree; it fails the same way on unmodified main here. CI has the full checkout. The full suite was not run locally; CI full-check covers it.
  • Dependencies / shared interfaces / integration assumptions (if applicable): none.

Remaining work and Issue closure

🤖 Generated with Claude Code

Removing infra and model left three sentences in module-layout.md that still state
Infra rules in the present tense. They now say what changed. The architecture
directory map gains the Apps delivery package, the Apps root compatibility exports and
the modules added since the map was last updated, so every package on disk is listed.

The contributor guide sent new models to harness/scenarios, whose one module runs any
external command as a trial and is the same for every model; it now names the serving
and Benchmark locations instead. The Harness, scenarios and views package docstrings
now describe what the packages hold, including the search evidence that views writes
for campaign import-search. No code changes.

Agent-assisted-by: Claude Code / claude-opus-5-5 [effort=xhigh] (author)
Signed-off-by: GUOGUO <xwdong1998@163.com>
zengchuang-hw
zengchuang-hw previously approved these changes Nov 21, 2026

@zengchuang-hw zengchuang-hw left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PASS

首轮独立检视:7a7ab84c3b5f26b20c098f439470d5bcfa972809 → 75b9872e78b70eb8602aedcf0e7c5146b5d0fe9f。本轮是 #498 后的文档收尾;#558 把真正改名单独跟踪,本 PR 没有更改路径、兼容边界或运行身份。

核对了目录图和当前源码:模型的服务与度量扩展点和模型无关的外部试验执行已分开,退役 Infra 的描述改为历史事实,Apps 视图的说明也明确记录了 campaign import-search 的写入。对三个 Python 文件分别解析 AST,去掉模块 docstring 后与 base 完全一致。未执行完整集成测试或查看 CI;未验证未来改名所需的配对 wheel 证据。

@Dong1017 Dong1017 added the kind:docs Documentation and template delivery label Nov 21, 2026
amy-why-3459
amy-why-3459 previously approved these changes Nov 21, 2026

@amy-why-3459 amy-why-3459 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Independent review of 7a7ab84c3b5f26b20c098f439470d5bcfa972809 → 75b9872e78b70eb8602aedcf0e7c5146b5d0fe9f (full diff). This is documentation follow-up to #498 only: no path, compatibility, or runtime-identity change.

I checked the directory map against the current main tree (7a7ab84c). The new Apps packages (delivery/, storage/, handoff/, workflows/, integrations/, legacy/), knowledge and harness additions, and the six view HTML templates are present. Spot-checked added map lines and the three package docstring updates against the modules themselves (apps/knowledge.py, knowledge/knowledge_find.py, harness/scenarios/external.py, and apps/views/search_attribution.import_search). The contributing.md / "Where to extend" table correctly sends new models to harness/serving and benchmark/metrics.py / validators, and describes external.py as model-independent.

Accuracy/performance comparison evidence is not applicable (docs and docstring-only changes). Architecture looks sound; the three __init__.py edits are docstring-only.

Merge should wait for green required checks. The harness/scenarios/ rename remains #558; if that rename lands, the new contributing.md and architecture table lines that still name harness/scenarios/external.py will need a follow-up.

cursor[bot]
cursor Bot previously approved these changes Nov 21, 2026

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

PR review verdict — PASS
Reviewed base 7a7ab84c3b5f26b20c098f439470d5bcfa972809 and head 75b9872e78b70eb8602aedcf0e7c5146b5d0fe9f.

Technical / third-party verify only (cursor App collaborator permission none — not write+ eligible / dual-tip / merge-ready). Author is Dong1017 — this is independent third-party verify, not a Dong self-vote.

Checked

  • Docs/layout sync after #498: architecture directory map adds missing modules; contributing/module-layout drop retired infra guidance; harness/scenarios/apps.views package blurbs match trial-execution role.
  • Tip already has amy + zeng Approves.

Ready note

  • Tip Ready full-check FAIL is the retired digest import in test_recovered_attempt_does_not_trust_a_rewritable_declaration — fixed on main by merged #556. Update branch onto that main and re-run Ready before steward merge.

…ry test

#457 merged after #498 removed infra/, and its new recovery test still imported digest
from inferrsi.infra.artifacts, so full-check fails on main. The value it forges is
compared by harness.optimization, which takes digest from harness.artifact_primitives,
so the test now imports that copy.

Agent-assisted-by: Claude Code / claude-opus-5-5 [effort=xhigh] (author)
Signed-off-by: GUOGUO <xwdong1998@163.com>
@Dong1017 Dong1017 changed the title docs: correct stale layout text and complete the directory map Follow up #498: fix a stale test import and correct the layout docs Nov 21, 2026
@Dong1017

Copy link
Copy Markdown
Collaborator Author

Pushed cce2159, which voids the approvals on 75b9872 (zengchuang-hw, amy-why-3459, cursor). Sorry for the extra round.

The only red check on 75b9872 was full-check, with 1 failure out of 5902: test_project_explanation.py::test_recovered_attempt_does_not_trust_a_rewritable_declaration. #457 merged after #498 removed infra/, and that new test still imports digest from inferrsi.infra.artifacts, so it fails on main too. The new commit changes only that import, to harness.artifact_primitives, which is the copy harness.optimization uses to compare the forged value. The docs commit is unchanged. The PR title and body now include the fix.

@zengchuang-hw zengchuang-hw left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NO PASS

增量检视:75b9872e78b70eb8602aedcf0e7c5146b5d0fe9f → cce2159c97d7a76d82620f05c1b19179c0e87eb6。上轮检视 的文档与 docstring 结论不变。本次唯一新增改动是 tests/test_project_explanation.py:497 的 digest 导入,不属于 #498 文档收尾范围。

批准前必做: 将文档改动同步到已包含 #556 的 main,保留主线的模块级 digest 导入,去掉本 PR 重复的函数内导入修正。我从 7a7ab84c、cce2159c 和 main@10ba7a55 读取了该文件,用隔离的 git merge-file 三方检查,确认该行发生冲突:主线删除了本地导入,PR 则替换该行。它不是文档问题,也不是 CI 状态问题。

未查看 CI、运行完整测试或实际合并。无其他非阻塞建议。

Copy link
Copy Markdown
Collaborator

Reviewed the increment 75b9872e78b70eb8602aedcf0e7c5146b5d0fe9f → cce2159c97d7a76d82620f05c1b19179c0e87eb6.

The only code change is tests/test_project_explanation.py:497, which replaces the in-function from inferrsi.infra.artifacts import digest with from inferrsi.harness.artifact_primitives import digest. That fix is already on main via merged #556, and it is outside the accepted #498 documentation follow-up.

I independently compared this file on the PR base 7a7ab84c3b5f26b20c098f439470d5bcfa972809, this head cce2159c97d7a76d82620f05c1b19179c0e87eb6, and current main 10ba7a5500bcd95949219b138f9ada5033b922b0. On main, digest is imported at module level (tests/test_project_explanation.py:12) so import failures surface at collection time, and the local import inside forge_then_crash was removed. A three-way merge of that line conflicts: main deletes the local import, this commit replaces it. GitHub also reports the PR as mergeable_state: dirty.

Please rebase the documentation changes onto current main (already contains #556) and drop this in-function import fix, keeping main's module-level import. I am not approving this head.

Accuracy/performance comparison evidence is not applicable (docs plus a test-import change). The earlier documentation conclusions on 75b9872e are unchanged.

#556 fixed the same stale import in tests/test_project_explanation.py with a
module-level import from harness.artifact_primitives. The merge keeps main's file, so
this branch no longer changes that test and its diff is the docs and docstrings only.

Agent-assisted-by: Claude Code / claude-opus-5-5 [effort=xhigh] (author)
Signed-off-by: GUOGUO <xwdong1998@163.com>

@zengchuang-hw zengchuang-hw left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PASS

增量检视 cce2159c97d7a76d82620f05c1b19179c0e87eb6 → caf2517c65f662b16e680023d028e14881357cb3。上轮 NO PASS 的重复导入和冲突已解决:新提交确实包含 main@10ba7a55,tests/test_project_explanation.py 与主线逐字节一致,保留了 #556 的模块级导入。相对主线只剩原先已通过的六个文档或 docstring 文件,均与 75b9872 逐字节一致。

我重新比对了精确提交、文件内容和三个 Python 文件去除模块 docstring 后的 AST,确认没有运行逻辑变化。没有新的阻塞项或非阻塞建议。未查看 CI 或运行完整测试;#558 的实际改名不在本 PR 范围内。

@Dong1017 Dong1017 changed the title Follow up #498: fix a stale test import and correct the layout docs docs: correct stale layout text and complete the directory map Nov 21, 2026
@Dong1017

Copy link
Copy Markdown
Collaborator Author

Merged main (10ba7a5) as caf2517 and kept main's tests/test_project_explanation.py, as asked: #556 had already fixed that import, so this PR no longer touches the test. Its diff is again the docs and the three docstrings, unchanged since 75b9872. Title and body are back to the docs-only scope. No approval was on record at cce2159, so this push voids none.

@Dong1017
Dong1017 enabled auto-merge (squash) November 21, 2026 13:08
@Dong1017

Copy link
Copy Markdown
Collaborator Author

@amy-why-3459 PTAL

@amy-why-3459 amy-why-3459 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

PR review verdict — PASS
Reviewed the increment cce2159c97d7a76d82620f05c1b19179c0e87eb6 → caf2517c65f662b16e680023d028e14881357cb3 (base 10ba7a5500bcd95949219b138f9ada5033b922b0).

The previous blocker is resolved: this head contains main@10ba7a55 / #556, tests/test_project_explanation.py is byte-identical to that main (and to current main@3bf0ae9f), and the file is no longer in the PR diff. The remaining six documentation/docstring files are byte-identical to the previously reviewed 75b9872e docs-only revision. GitHub reports mergeable: true against current main. Ready-lane checks on this head have completed successfully.

Accuracy/performance comparison evidence is not applicable (docs and docstrings only). I did not rerun the test suite locally. I also saw the PTAL in 7063057382; this approval is bound to caf2517c.

@Dong1017
Dong1017 merged commit 15f1703 into main Nov 21, 2026
12 checks passed
@Dong1017
Dong1017 deleted the impl/layout-docs branch November 21, 2026 13:11
Dong1017 added a commit that referenced this pull request Nov 21, 2026
Main gained #559 as a squash commit and #541's release workflow. The docs and the scenarios initializer conflicted only because this branch already carried #559's text with the rename on top; the merge keeps this branch's versions, and trials/__init__.py equals main's scenarios/__init__.py byte for byte. release.yml merged cleanly and still passes INFERRSI_PRE_CHANGE_SESSIONS to its one check_installed run.

Agent-assisted-by: Claude Code / claude-opus-5-5 [effort=xhigh] (author)

Signed-off-by: GUOGUO <xwdong1998@163.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind:docs Documentation and template delivery

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants