add a bilingual authoring cookbook - #78
Conversation
|
Thanks for adding the bilingual authoring cookbook. The structure is useful, and I reproduced the I found two items that should be fixed before merge:
Small cleanup: both new Markdown files also have a blank line at EOF ( There are currently no GitHub check results on this head, so please include the refreshed test and visual-check receipts after updating both language versions. |
|
Addressed the maintainer review comments in the latest commit. The updated PR description contains the exact verification commands and results. |
|
Thanks for the thoughtful bilingual cookbook. The technical content is solid, and the documented path is reproducible. I would like to discuss one product-positioning point before we merge it. Archify is primarily an Agent-facing Skill, so the normal user journey should be:
In that default path, users should not need to learn the schema or manually run Would you be open to making that positioning explicit near the top? For example, one short note could say that normal users can simply ask a Skill-capable Agent to generate the diagram, and that the manual workflow below is a reference for integration, contribution, and troubleshooting. We could also label the README link accordingly. What do you think? If this matches your intent, I believe it only needs a small wording adjustment, not a larger rewrite or expansion. |
Problem and value
The repository has a strong Skill contract, but a first-time user still has to assemble the install, type-selection, validation, delivery, Architecture Delta, and visual-review steps from several files.
This PR adds a focused English/Chinese authoring cookbook and links it from all three README language surfaces.
Scope
docs/authoring-cookbook.md.docs/authoring-cookbook.zh-CN.md.README.md,README_EN.md, andREADME_ZH.md.archify.zipchanges.Non-goals
Tests run
node bin/archify.mjs doctor— passed.node bin/archify.mjs guide "Show an API request with a Redis cache miss" --json— passed.--lang zh— passed.node bin/archify.mjs validate sequence examples/cache-miss-request.sequence.json --quality showcase --json— passed: 9/9 checks, 0 errors, 0 warnings.npm test— the repository suite reached two environment-specific failures on Windows: preview termination expects a clean SIGTERM exit, and the Cursor archive test requires the Unixunzipexecutable. The documentation-related checks passed.Generated artifacts
None. This PR changes documentation only;
archify.zipremains fresh.Visual evidence
Not applicable.
Review follow-up
Addressed all requested items:
Fresh verification: