Skip to content

Add a bilingual validation troubleshooting guide - #77

Open
smf-h wants to merge 1 commit into
tt-a1i:mainfrom
smf-h:docs/troubleshooting-guide
Open

Add a bilingual validation troubleshooting guide#77
smf-h wants to merge 1 commit into
tt-a1i:mainfrom
smf-h:docs/troubleshooting-guide

Conversation

@smf-h

@smf-h smf-h commented Aug 16, 2026

Copy link
Copy Markdown

Problem and value

Validation failures currently expose useful structured data, but contributors need a short guide for interpreting stage, diagnostic prefixes, subject, evidence, and supportedFixes.

This PR adds an English/Chinese troubleshooting guide and points contributors to it before opening an issue.

Scope

  • Added docs/troubleshooting.md.
  • Added the matching Chinese guide at docs/troubleshooting.zh-CN.md.
  • Added one link from CONTRIBUTING.md.
  • No renderer, schema, CLI, generated artifact, or archify.zip changes.

Non-goals

  • No new diagnostic codes.
  • No change to validation or delivery behavior.
  • No claims that deterministic checks replace visual review.

Tests run

  • Relative documentation targets were checked locally.
  • This is a documentation-only change; renderer and CLI behavior are unchanged.

Generated artifacts

None. This PR changes documentation only; archify.zip remains fresh.

Visual evidence

Not applicable.

Review follow-up

Addressed the remaining completeness issue and brought the branch up to date with current main:

  • Documented Architecture compare stages separately from validate/deliver: input, prepare, validate, compare, artifact, commit, and internal.
  • Noted that a snapshot failing its final HTML checks during compare can also report check.
  • Added the 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.
  • Added a short compare-failure section covering delta/base-input, delta/relationship-id-required, delta/artifact-invalid, and delta/commit-target.
  • Kept the English and Chinese guides aligned.
  • Rebased onto current main (146b6d4e) so remote CI can run on this head.

@smf-h smf-h changed the title docs: add a bilingual validation troubleshooting guide Add a bilingual validation troubleshooting guide Aug 16, 2026
@tt-a1i

tt-a1i commented Aug 17, 2026

Copy link
Copy Markdown
Owner

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:

  1. Both cookbook links are currently broken: docs/authoring-cookbook.md and docs/authoring-cookbook.zh-CN.md are not present in this PR or on main. Please remove/defer these links, link to existing documents, or explicitly resolve the dependency before merge. The PR description should also be updated because the statement that all relative documentation targets were checked is not reproducible at this head.

  2. The "Identify the failure stage" section currently lists diagnostic-code families, but does not explain the actual receipt field stage. Current values are input, render, and check; most schema/relationship/guided-view/clean-flow/legend/engineering/output/repository-evidence diagnostics occur under render, while composition/artifact failures occur under check. Please explain stage separately from diagnostic prefixes and include the current repository-evidence/* and internal/* families.

Small wording fix: for clean-flow/edge-through-node, the suggested action should be to reroute the relationship around the unrelated node, not to remove a node from the route. The later example already describes this correctly.

Please keep the English and Chinese guides aligned when updating these sections.

@smf-h

smf-h commented Aug 17, 2026

Copy link
Copy Markdown
Author

Addressed the maintainer review comments in the latest commit. The updated PR description contains the exact verification commands and results.

@tt-a1i tt-a1i left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

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.

Comment thread docs/troubleshooting.md Outdated
| `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.

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

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.

@smf-h smf-h Aug 20, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

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.

@smf-h
smf-h force-pushed the docs/troubleshooting-guide branch from e1edda3 to 68d6351 Compare August 20, 2026 17:53
@smf-h

smf-h commented Aug 20, 2026

Copy link
Copy Markdown
Author

Addressed the remaining completeness issue in the latest head.

Architecture compare is now documented with its actual stages (input, prepare, validate, compare, artifact, commit, and internal), plus check when a snapshot fails its final HTML checks. The prefix table includes delta/*, and a short compare-failure section covers delta/base-input, delta/relationship-id-required, delta/artifact-invalid, and delta/commit-target. English and Chinese stay aligned.

The branch is rebased onto current main so remote CI can run on this head.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants