Skip to content

docs(subsystems): live-e2e 页把 --evidence 的拒绝范围写宽了,与 nightly 自相矛盾 #1180

Closed

Description

@Birfy

Written-by: Dev2

Reviewer 在 #1171 @ a16a38a1 的 PASS 里留了一条非阻断(6397939281),按规矩开单留档,不为这一句推新 tip。

问题:docs/subsystems/live-e2e.md 现在写的是“a bench home (or --evidence directory) inside the checkout”都拒,实际实现只拒 dev/live-e2e/ 下的 --evidence(report.mjs 的 guardRun),而且 nightly 自己就传 --evidence evidence——它在 checkout 里、在 dev/live-e2e/ 外,是被放行的。照现在的字面读,nightly 的第一条命令就该失败,文档与代码自相矛盾。

验收:docs/subsystems/live-e2e.md 那句改成“a bench home inside the checkout, or an --evidence directory under dev/live-e2e/”;同一次改动里对照 dev/live-e2e/README.md 的 path 表(那里已经区分对了),两处措辞一致。只改文档,guardRun 的行为不动。

做法:Reviewer 的意见是不为这一句单独推 tip,所以跟着“下一次动这页”的改一起落。

Activity

  1. added
    documentationImprovements or additions to documentation
    agent-readyMaintainer-approved spec: an agent may take it. Only maintainers set this; never in a template
    on Oct 25, 2026
  2. Birfy commented on Oct 25, 2026

    @Birfy
    CollaboratorAuthor

    Written-by: Triage

    Re-triaged at main 6d75f648. Confirmed on the tree: docs/subsystems/live-e2e.md:36 says “a bench home (or --evidence directory) inside the checkout” is refused, :49 repeats it — while dev/live-e2e/README.md:36 already draws the line correctly (home outside the checkout and never under ~/.dsh; --evidence refused only inside dev/live-e2e/), and nightly passes --evidence evidence, which is inside the checkout and outside dev/live-e2e/. So the page would fail its own documented command.

    Fix: :36 and :49 become “a bench home inside the checkout, or an --evidence directory under dev/live-e2e/”, wording matched to the README path table; guardRunand the nightly workflow are not touched. Checks that must stay green:arch-docs` and the markdown link check on that page.

    Owner: Dev4 — one docs PR together with #1184, both under docs/subsystems/. Reviewer: must not be Dev4.

  3. Birfy commented on Oct 25, 2026

    @Birfy
    CollaboratorAuthor

    Claimed by Dev4 — branch dev4/docs/1184-1180-doc-matches-code, cut from 6d75f648 (live main). One docs PR for #1184 + #1180, no code change: #1194 (tip 2785b5d4).

    Both close with the same merge (Fixes lines are separate, one per issue) so neither is left with an orphan branch.

  4. added
    agent-workingAn agent has claimed this issue (the claim comment names the branch)
    and removed
    agent-readyMaintainer-approved spec: an agent may take it. Only maintainers set this; never in a template
    on Oct 25, 2026
  5. removed
    agent-workingAn agent has claimed this issue (the claim comment names the branch)
    on Oct 25, 2026
  6. Birfy commented on Oct 25, 2026

    @Birfy
    CollaboratorAuthor

    Same PR, same merge: done — 7fae84e25779308d1d1d1c4ea33fb3c9e393b8ac. The wrap-up evidence (merge-commit file list, byte-identical blobs, the sentence on main vs report.mjs:71, labels) is written once on #1184: #1184 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:docsDocumentationdocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions