Problem
The automated sync job that pushes changes from the internal closed-source repository to this public repository periodically overwrites documentation that was added directly in the public repo.
This has now happened at least twice:
The root cause is that the sync script treats the internal repo as the source of truth for all files, including Docs/. Any documentation changes made directly in this public repository are not reflected back into the internal repo, so the next auto-sync silently overwrites them.
What gets lost
Each time a sync runs, the following content has been stripped:
Docs/source/pages/alttester-editor.md — settings descriptions added in the public repo (Keep AltTester® prefab in scene, App Name, Show Native Popup Option)Docs/source/pages/alttester-with-appium.md — the entire Selenium / WebGL testing section, the Connection settings popup section, and all associated C#/Java/Python/Robot code examplesDocs/source/_static/examples~/appium/ and examples~/selenium/ — example files deleted entirelyDocs/source/pages/known-issues.rst — known issue entries added after the last sync
Impact
Documentation is silently degraded on every sync cycle. Users lose access to accurate, up-to-date documentation without any visible indication that content has been removed.
Proposed fix
One of the following approaches should be adopted:
- Exclude
Docs/ from the auto-sync — treat the public repo as authoritative for documentation. All doc changes would be made here and never overwritten.
- Sync doc changes back to the internal repo first — before merging any doc PR in the public repo, port the changes to the internal repo so the next sync carries them forward rather than reverting them.
- Add a post-sync validation step — after each auto-sync PR is merged, run a diff against the previous public-repo state and fail/alert if existing content was removed from
Docs/.
Related
Problem
The automated sync job that pushes changes from the internal closed-source repository to this public repository periodically overwrites documentation that was added directly in the public repo.
This has now happened at least twice:
4e5bd5b0), fixed in PR Docs: auto-sync from closed-source repo repeatedly overwrites public-repo-only documentation #1975The root cause is that the sync script treats the internal repo as the source of truth for all files, including
Docs/. Any documentation changes made directly in this public repository are not reflected back into the internal repo, so the next auto-sync silently overwrites them.What gets lost
Each time a sync runs, the following content has been stripped:
Docs/source/pages/alttester-editor.md— settings descriptions added in the public repo (Keep AltTester® prefab in scene, App Name, Show Native Popup Option)Docs/source/pages/alttester-with-appium.md— the entire Selenium / WebGL testing section, the Connection settings popup section, and all associated C#/Java/Python/Robot code examplesDocs/source/_static/examples~/appium/andexamples~/selenium/— example files deleted entirelyDocs/source/pages/known-issues.rst— known issue entries added after the last syncImpact
Documentation is silently degraded on every sync cycle. Users lose access to accurate, up-to-date documentation without any visible indication that content has been removed.
Proposed fix
One of the following approaches should be adopted:
Docs/from the auto-sync — treat the public repo as authoritative for documentation. All doc changes would be made here and never overwritten.Docs/.Related