Connect and Disconnect
updated
Connecting takes two steps: give the workspace access to repositories, then pair one with a project.
1. Install the GitHub App
Under Repositories in the workspace sidebar, the workspace owner installs the Meldoc GitHub App and chooses which repositories it may see. The owner then selects Allow for the repositories projects may use. The app needs Checks: read and write for the Sync Check and Documentation Review.
2. Pair a repository with a project
In the project’s Repositories tab, a project administrator selects Connect repository, picks the repository and the folder that holds this project’s documentation, and chooses which checks to enable. Meldoc syncs the repository’s default branch.
Which files are documents comes from meldoc.config.yml — the same file the CLI reads, see Configuration. If the repository doesn’t have one yet, or it doesn’t mention this project, Meldoc opens a pull request that adds it.
Disconnect
- Unpair a project — Disconnect on the repository’s card in the project’s Repositories tab. Documents and files both stay; pairing again later starts with a full comparison. Merge or close any open Meldoc pull request yourself.
- Remove a repository from the workspace — under Repositories in the workspace sidebar. Every project paired with it stops syncing.
- Disconnect GitHub entirely — Disconnect under Repositories in the workspace sidebar. Every pairing stops.
Keep in mind: If a Meldoc check is required in a repository’s branch protection, remove that rule in GitHub before disconnecting, or pull requests will wait forever.
What’s next?
How a Sync Runs — How syncing works once connected.
Meldoc CLI — Syncing from your own machine instead.