Connecting GitHub Cloud

Accessing Git Connection Settings

To access GitHub Connection settings go to Group dashboard > Group Settings > Git Connection.

A new Git repository is required and must be completely empty—no commits or files (e.g., README.md)—before connecting to ReadMe. You can add or remove files after setup.

After selecting "Sync with GitHub," you will be required to authenticate with GitHub.

Connecting GitHub Cloud

After setup, you will see all of your projects in the group. You can also filter by name, first sync, last sync, and status. You will need to select which repository should map to your ReadMe project. Additional repos can be added via GitHub.

Managing and Disconnecting Projects

Once a ReadMe project is connected a GitHub repository, you can click on the Connected button to manage the connection or disconnect the connection.