Connect your GitHub repo
Install the GitHub App, pick a repository, and publish on every push.
Install the GitHub App, pick a repository, and publish on every push.
Sambadocs builds your site straight from a GitHub repository. You connect a repo once through the Sambadocs GitHub App; after that, every push to your default branch republishes the site automatically.
Connecting a repo installs the Sambadocs GitHub App on your account or organization. During install, GitHub asks which repositories to grant access to:
Pick only the repositories you want Sambadocs to build. You can grant a single repo, and you can change the selection later from your GitHub settings — Sambadocs never gets access to repos you didn't select.
The App needs read access to your repository contents (to read your
Markdown, docs.json, and any OpenAPI spec) and to receive push events
(so it knows when to rebuild).
Once the App is installed, Sambadocs lists the repositories it can see. Choose the one that holds your docs and create a project from it. If a repo is already wired up to another project, it shows as taken.
After a repo is connected, you don't deploy manually. Each push to the default branch fires a webhook, and Sambadocs runs the build pipeline:
docs.json, compiles every page, and validates an
OpenAPI spec if you have one.You manage which repositories Sambadocs can reach from your GitHub Settings → Applications → Sambadocs. Add or remove repositories there at any time; removing a repo stops future builds for projects based on it.
Builds publish from your repository's default branch (usually
main). Work on other branches won't change the live site until it's
merged in.