Docsio
DocumentationGuides
GitHub Sync

How sync works

Two-way sync at publish boundaries. Edits commit on Publish; pushes pull and rebuild automatically.

Docsio synchronizes eligible documentation content at publishing and repository-push boundaries. Saving an editor draft does not create a GitHub commit by itself.

Publish (Docsio → GitHub)

When you publish, Docsio compares eligible project files with the connected repository and prepares the changes. For a writable target branch, it commits those changes and continues the publication flow.

If the target branch requires a pull request, Docsio can write to a sync branch and open or update a PR. The GitHub settings panel links to it. Review and merge the PR in GitHub rather than disabling branch protection just to sync docs.

Push (GitHub → Docsio)

A push to the configured branch triggers a webhook. Docsio checks the event, reads eligible files, applies the incoming content and starts a build. Check sync and build status before assuming the new version is live.

Other branches and files outside the content allowlist do not become project content through this connection.

What happens if both happen at once

Coordinate work on the same pages. An incoming sync can preserve the current editor draft before applying repository content. If you see a preserved-draft or conflict notice, review it before publishing more changes.

A branch that changes during an outgoing sync can require a retry rather than being overwritten. Read the status and inspect both versions when there is overlapping work.

Self-commit detection

Docsio identifies its own sync events to avoid a loop of repeated imports and publications. You do not need to edit commit messages or manually disable webhooks.

Rebuild speed

The time from a push to a live update varies with the site and build. A webhook being received is not the same as a successful deployment. Use the status shown in Docsio and verify the live page.

When commits happen

The first outgoing sync can seed a repository. Later publications can commit changed documentation. Your team's own GitHub commits arrive through the inbound sync flow.

Keep exploring

Supported files · Team workflow
Need a hand? Talk to the Docsio teamClear docs. Happier readers.

On this page