Skip to content

Docs: auto-sync from closed-source repo repeatedly overwrites public-repo-only documentation #1975

Closed

Description

@andreion1ca

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 examples
  • Docs/source/_static/examples~/appium/ and examples~/selenium/ — example files deleted entirely
  • Docs/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:

  1. Exclude Docs/ from the auto-sync — treat the public repo as authoritative for documentation. All doc changes would be made here and never overwritten.
  2. 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.
  3. 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

Activity

  1. self-assigned this
    on Jun 16, 2026
  2. MihaiCuc98 commented on Jun 26, 2026

    @MihaiCuc98
    Contributor

    Agreed with @andreion1ca that there's no need fo further testing and considering that the #1973 is in done, I will move this ticket also to Done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions