Skip to main content

GitHub

Integrate Komment with your GitHub projects in 5 easy steps.

Prerequisites​

  • A GitHub account. You can set one up here.
  • At least one repository with supported files on GitHub. Follow these steps to create a repo.

Steps​

  1. Click the New Connection button in the menu bar.

Find New Connection in menu

  1. Choose GitHub from the pop-up box listing Git platforms.

Select GitHub in list of git platforms

  1. If you have access to an organisation account in addition to a personal account, you will be asked to choose which account to install Komment on. Select the appropriate account by clicking on it.

Select GitHub account to install Komment

  1. You will be directed to GitHub’s installation page for Komment. Select All repositories. Then click the green Install button at the bottom.

Select repositories to install Komment

We recommend installing Komment on all your repositories so that newly created repos in your GitHub account are documented without requiring manual enablement each time. It’s a frictionless way for you to enjoy continuous documentation across all your repos 😌

Alternatively, you can select Only select repositories and choose the specific repos you want to document with Komment.

Select repositories to install Komment

  1. You'll be redirected back to the Komment dashboard. System logs will confirm which repositories Komment has been granted access to.

Successful Komment installation

You can now begin documenting your codebase with Komment! 🎉