Connect a repo
Walk through connecting your first GitHub repo, install the app, pick the repo, run the first sync.
The project owner connects GitHub from Settings → GitHub. You also need the necessary GitHub access to install or authorize the app for the selected account and repository.
1. Open the GitHub tab
Select Connect GitHub. If you already installed the app but the connection is incomplete, use Already installed? Finish connecting.
2. Install the Docsio app
Authorize the app in GitHub and select the repositories Docsio may access. Selecting only the repositories you need keeps the scope clear. For an organization, an owner may need to approve the installation or updated permissions.
The app uses repository access to read and write eligible documentation files. For organization installations, read-only organization membership access helps verify that the person linking the installation is authorized. It does not let Docsio change organization membership.
3. Pick org, repo, branch
Return to Docsio and select the installation or organization, repository and branch. If your docs live in a subdirectory, enter that folder. Paths inside the selected folder must match the supported content structure.
4. Pick the first-sync direction
| Direction | Use when |
|---|---|
| GitHub → Docsio | The repository contains the documentation to import |
| Docsio → GitHub | Your Docsio draft should supply the initial repository content |
An empty repository needs a push from Docsio to create its first content. If both sides contain work, review and back up that content before choosing a direction.
5. Save changes
Select Save changes to run the initial sync. Installing the app alone does not complete this step. Read the status after it finishes and resolve any reported access or content-path issue.
6. Verify the sync
Check the connected repository, branch and sync status in settings. Inspect the files in GitHub and the pages in the Docsio preview. If a protected branch requires a PR, follow the displayed link and review it in GitHub.
Common gotchas
- No repository listed: check the installation's selected repositories and pending organization approval.
- App installed but connection inactive: finish authorization in Docsio, then choose the repository and save.
- Wrong folder: confirm it contains supported documentation paths, not only application source files.
- Sync needs attention: read the displayed error before forcing another sync.