How two-way sync works
Keep a Falconer space and a GitHub repository in sync, in both directions.
Two-way sync is built for teams that keep their docs as Markdown in a repository. Engineers keep working in Git, and everyone else edits the same docs in Falconer.
How it works
Section titled “How it works”A synced space mirrors one path of a repository on one branch.
- From GitHub to Falconer: commits to the synced branch are pulled into the space automatically.
- From Falconer to GitHub: edits you make in Falconer are pushed as a commit or a pull request when you’re ready.
Nothing reaches GitHub until someone pushes it, so you can draft and edit in Falconer without touching the repository.
When the same document changes on both sides, Falconer shows a conflict and lets you choose which changes to keep.
What maps to what
Section titled “What maps to what”| In the repository | In Falconer |
|---|---|
.md and .mdx files | Documents in the Docs tab |
| Directories | Folders |
| Images and every other file | Files in the Files tab |
The sync loop
Section titled “The sync loop”- Set up two-way sync on a space and import the repository.
- Edit documents in Falconer. Sync status shows what hasn’t been pushed yet.
- Push your changes as a commit or a pull request.
- Changes made on GitHub flow back into Falconer.
Learn more
Section titled “Learn more”- Move, rename, and delete
- Images and other files
- Manage or disconnect sync
- Supported Markdown and limits
Note: Two-way sync is different from keeping docs in sync with PRs, which proposes doc updates when merged code changes affect your documentation.