docs: make workflow sync one-command - #23
Merged
Merged
Conversation
wlvh
marked this pull request as ready for review
August 9, 2026 12:23
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Base / head
mainat821a32a8221d6eb3b808b65ce0cd682905dc57f6agent/docs-first-installation-onboardingat192d415834b6ef36d78d46c447bc278447e91e84192d415834b6ef36d78d46c447bc278447e91e84Changed files
The full PR contains:
README.mdzh/README.mden/README.mdzh/skills/workflow-docs-sync/SKILL.mdzh/skills/workflow-docs-sync/agents/openai.yamltests/test_workflow_docs_sync.pyThe corrective commit changed only
README.md,zh/README.md,en/README.md,zh/skills/workflow-docs-sync/SKILL.md, andtests/test_workflow_docs_sync.py. It did not changeagents/openai.yaml,sync_docs.py, either installer, downstream templates, DEC files, or eval files.allow_implicit_invocation: falseremains unchanged.Confirmed corrections
WDS-I18N-07:zh/README.mdcontains the exact Chinese first-installation prompt once.en/README.mdand the English root README each contain the exact equivalent English prompt once. The two public prompts are intentionally not byte-identical and remain in their first-use entrypoints.WDS-TEST-08:FIRST_USE_PROMPTis split intoZH_FIRST_USE_PROMPTandEN_FIRST_USE_PROMPT. Scenario 5 checks each public copy-paste prompt and its entrypoint, while the 24 ordinary-proseSKILL.mdsubstring snapshots were removed. Skill structure, exact public CLI contracts, distribution identifiers, andallow_implicit_invocation: falseremain covered.WDS-ISOLATION-04: original-worktree protection no longer hashes the whole repository or compares raw Git index-file bytes. It captures NUL-delimited status, staged entries, and ignored-path enumeration; freezes only the invocation-time non-clean/ignored path set; records type, mode, regular-file SHA-256, symlink target, or missing state for that set; then rechecks the same set plus status and staged entries. New ignored paths are not globally rescanned, and detected concurrent changes are not attributed to the Agent without evidence.WDS-ONBOARDING-09: both detailed READMEs now distinguish the first-installation instruction from normal use after installation in another project.The existing same-turn installer continuation, target/language/PR inference, external clean worktree, Draft-only publication, explicit staging, out-of-repository PR body, and remote readback contracts remain in place.
Exact validation
PYTHONDONTWRITEBYTECODE=1 /Users/lyuhongwang/opt/anaconda3/bin/python3 -m pytest -q -p no:cacheprovider tests/test_workflow_docs_sync.py -k scenario_5— PASS,1 passed, 4 deselected in 0.68s.PYTHONDONTWRITEBYTECODE=1 /Users/lyuhongwang/opt/anaconda3/bin/python3 -m pytest -q -p no:cacheprovider— PASS,5 passed in 60.01s.PYTHONDONTWRITEBYTECODE=1 /Users/lyuhongwang/opt/anaconda3/bin/python3 /Users/lyuhongwang/.codex/skills/.system/skill-creator/scripts/quick_validate.py zh/skills/workflow-docs-sync— PASS,Skill is valid!.PYTHONPYCACHEPREFIX=<external-validation-dir>/pycache python3 -m py_compile zh/skills/workflow-docs-sync/scripts/sync_docs.py zh/scripts/install_skills.py— PASS.PYTHONDONTWRITEBYTECODE=1 python3 zh/skills/workflow-docs-sync/scripts/sync_docs.py --help— PASS; public commands remain{prepare,check}.git diff --check— PASS before staging.git diff --cached --check— PASS after explicitly staging exactly the five corrective paths.git show --check HEAD— PASS after commit.git status --porcelain=v1 -z --untracked-files=all --ignoredcomparison — PASS; no repository residue was added.pytest— PASS for push run 31246083319 and pull_request run 31246085744.Environment limitations recorded without converting them into candidate failures:
PYTHONDONTWRITEBYTECODE=1 python3 -m pytest -q -p no:cacheprovider—BLOCKED: the Homebrew Python has nopytestmodule.PYTHONDONTWRITEBYTECODE=1 python3 /Users/lyuhongwang/.codex/skills/.system/skill-creator/scripts/quick_validate.py zh/skills/workflow-docs-sync—BLOCKED: the Homebrew Python has noyamlmodule.One-prompt Codex E2E
One-prompt Codex E2E: NOT_RUNThe exact README prompt resolves
/tree/main/at remotemaincommit821a32a8221d6eb3b808b65ce0cd682905dc57f6, while this Draft candidate is192d415834b6ef36d78d46c447bc278447e91e84. The system installer honors the URL ref, so running the prompt before merge would install and test the priormainSkill rather than this candidate. Under the explicit constraints not to merge and not to change the prompt, that run cannot provide candidate product acceptance. No disposable test PR was created.Review and final status
A fresh-context, read-only contract review of the frozen five-file corrective diff returned
PASSwith noBLOCKERorWARN. It checked the bilingual entrypoints, retained machine contracts, targeted worktree proof, allowlist, and unchanged implicit-invocation policy.