Connecting GitHub

Choose which repository, branch, and folder docu.fast should read. Your documentation stays in Git.

Sign in

Use your invited GitHub account to enter the hosted app. Signing in establishes your identity; it does not grant access to all your private repositories.

Choose a public repository

Repository suggestions include public repositories owned by your GitHub account and repositories already granted to docu.fast. Search and select a suggestion, or enter a repository URL or its owner and name, then choose Find documentation. Public repositories do not require an app installation.

For example, if your repository is at https://github.com/your-team/your-project, you can enter your-team/your-project. Replace these illustrative names with your own repository.

Connect a private repository

Use Connect private repositories to grant the GitHub App read-only contents and metadata access to the repositories you select. docu.fast does not add files, workflows, or plugins to the repository.

Private-repository onboarding remains under validation during early access. If suggestions are empty, you can still enter a public repository directly. An empty suggestion list does not establish access to a private repository.

Select the branch and folder

Select the branch you use for documentation, then choose the folder that contains your Markdown. Choose the content folder rather than the repository’s build tooling or dependency directory.

A minimal documentation folder can look like this:

docs/
  README.md
  installation.md
  configuration.md

Commit and push your changes to the connected branch before checking for updates. Local edits and unmerged changes on another branch will not appear on that site.

Understand what gets imported

Each import reads an exact Git revision. A preview retains that content so a later branch change cannot silently replace the version you reviewed.

The source repository’s configuration code and build scripts are not executed. Supported metadata can supply defaults; explicit settings in docu.fast take precedence.

Next: Organizing navigation.