Instruction file imported from doqltl179/Mu3Library_ForUnity (
.github/instructions/docs-sync.instructions.md). Copyright stays with the author.
--- description: "Documentation synchronization policy for multilingual Mu3Library docs"
Docs Sync Instructions
Scope
README.mddocs/readme/README.ko.mddocs/readme/README.ja.mdCHANGELOG.mddocs/changelog/CHANGELOG.ko.mddocs/changelog/CHANGELOG.ja.md
Rules
- If behavior/public API changes, update the primary English doc in the same task.
- When
README.mdis updated,docs/readme/README.ko.mdanddocs/readme/README.ja.mdmust be updated in the same task. - When
CHANGELOG.mdis updated,docs/changelog/CHANGELOG.ko.mdanddocs/changelog/CHANGELOG.ja.mdmust be updated in the same task. - When
CHANGELOG.mdis updated, evaluate whetherREADME.mdalso needs updating (e.g., new features, changed API signatures, new define symbols, updated usage examples). If so, updateREADME.mdand its localized files in the same task. - Do not defer README/CHANGELOG localization updates unless explicitly requested by the user.
- Keep section structure and visual style synchronized across languages, not only the text content.
- Avoid documenting unverified behavior.
Update Quality
- Keep examples consistent with real code signatures.
- Keep feature lists and define-symbol sections synchronized across languages.
- Prefer concise and explicit wording over marketing language.