Add a bilingual validation troubleshooting guide - #77
Conversation
|
Thanks for adding the bilingual troubleshooting guide. I ran the documented commands and the full suite locally against the current main (629/629 passed), but there are two items to fix before merge:
Small wording fix: for Please keep the English and Chinese guides aligned when updating these sections. |
|
Addressed the maintainer review comments in the latest commit. The updated PR description contains the exact verification commands and results. |
tt-a1i
left a comment
There was a problem hiding this comment.
Thank you for addressing the previous feedback and keeping the English and Chinese guides aligned. This is a useful troubleshooting reference: the distinction between receipt stages, diagnostic prefixes, deterministic checks, and human visual review is much clearer now. I merged this head with the current main locally and the focused repair-receipt, output-path, and Architecture Delta suites pass 40/40.
There is one remaining completeness issue in the documented compare path; see the inline comment. The branch is also behind current main and GitHub reports no checks for this head, so please update it and let the remote CI suite run after the documentation fix.
| | `render` | The renderer rejected the source or its authored facts/layout | Read `diagnostics[]` and repair the named subject | | ||
| | `check` | The final HTML artifact or composition checks failed | Read `checker` and composition diagnostics before changing source | | ||
|
|
||
| `deliver` can also report `prepare`, `receipt`, and `commit` when it cannot create a candidate, read a verified receipt, or replace the target. Architecture `compare` can report `compare` while classifying the two snapshots. |
There was a problem hiding this comment.
Thanks for separating stages from code prefixes. The compare description is still incomplete: current Architecture compare failures can report input, prepare, validate, compare, artifact, commit, and internal, not only compare. It also owns a current delta/* diagnostic family (delta/base-input, delta/relationship-id-required, delta/artifact-invalid, delta/commit-target, etc.), but that family is absent from the prefix table below. Since the guide explicitly introduces compare, please document its actual stages and add delta/* with an appropriate first action in both language versions. Alternatively, remove the partial compare statement and keep this guide explicitly scoped to validate and deliver.
There was a problem hiding this comment.
Documented the actual Architecture compare stages (input, prepare, validate, compare, artifact, commit, and internal) and added the delta/* family to the prefix table in both language versions, with a short compare-failure section for the named codes.
e1edda3 to
68d6351
Compare
|
Addressed the remaining completeness issue in the latest head. Architecture The branch is rebased onto current |
Problem and value
Validation failures currently expose useful structured data, but contributors need a short guide for interpreting
stage, diagnostic prefixes,subject,evidence, andsupportedFixes.This PR adds an English/Chinese troubleshooting guide and points contributors to it before opening an issue.
Scope
docs/troubleshooting.md.docs/troubleshooting.zh-CN.md.CONTRIBUTING.md.archify.zipchanges.Non-goals
Tests run
Generated artifacts
None. This PR changes documentation only;
archify.zipremains fresh.Visual evidence
Not applicable.
Review follow-up
Addressed the remaining completeness issue and brought the branch up to date with current
main:comparestages separately fromvalidate/deliver:input,prepare,validate,compare,artifact,commit, andinternal.check.delta/*family to the prefix table, with a first action to repair the named snapshot or output target and keep the previous HTML/receipt pair.delta/base-input,delta/relationship-id-required,delta/artifact-invalid, anddelta/commit-target.main(146b6d4e) so remote CI can run on this head.