doc-sync-check

Use a change-type checklist that maps each modification (feature, API, configuration, installation) to the specific documentation files requiring updates. Update docs in the same PR as the code change, and verify links and examples before committing.

Update the API reference file with new or changed endpoints, request/response examples, error codes, and authentication requirements. Also update workflow definitions and usage examples that reference the endpoint, plus both language versions of each file.

Maintain paired files using a .zh-CN.md suffix convention, update both versions in the same commit, and ensure language-switch links work in both directions. Content should be semantically equivalent, not machine-translated, with working relative links in each variant.

No, pure documentation commits do not require lint or build validation. However, you must manually verify that links work, both language versions are updated, and command examples match what actually exists in the repository.

Common anti-patterns include documenting commands that do not exist, updating only one language version, describing outdated behavior after code changes, leaving broken links, and documenting unimplemented future features.