Suggest in GitHub

Suggest in GitHub is generally used in two main ways. The first is to propose a change, such as correcting a typo or updating technical details. The second is to leave a comment or give general feedback, without directly changing the content.

Suggested in GitHub are available on on all plans.

Who Uses Suggested in GitHub

There are two personas who interact with Suggest in GitHub:

• Anyone consuming your public documentation (developers, partners, etc.). They can use Suggest in GitHub to flag typos or share user feedback.
• Anyone who contributes and collaborates on your documentation (technical writer, product manager, etc.). They can use Suggested Edits to propose improvements and review docs with inline feedback.

Enabling Suggest in GitHub

1. You must have bi-directional sync set up with a public repository to enable Suggest in GitHub.

2. To enable Suggest in GitHub on your public docs, go toSettings in your Admin Dashboard > Page Settings. Select Show to show a link to your public GitHub repository on your docs.