Getting Started with DocInsights.io
DocInsights.io is a simple feedback collection platform that helps you gather ratings and comments on your documentation. Here's how to get started:
1. Create a Project
First, create a project to organize your feedback collection:
- Go to the Projects page
- Click "Create New Project"
- Enter a title and optional description
- Your project will get a unique UID for integration
2. Add Markdown Rating Links
Create simple rating systems using markdown syntax for your GitHub README files and documentation:
Simple 1-10 Rating with Links
## Rate this project How helpful was this documentation? - [1] Poor - [Rate 1/10](https://docinsights.io/feedback/1/PROJECT-UID/github-repo) - [2] Below Average - [Rate 2/10](https://docinsights.io/feedback/2/PROJECT-UID/github-repo) - [3] Average - [Rate 3/10](https://docinsights.io/feedback/3/PROJECT-UID/github-repo) - [4] Fair - [Rate 4/10](https://docinsights.io/feedback/4/PROJECT-UID/github-repo) - [5] Good - [Rate 5/10](https://docinsights.io/feedback/5/PROJECT-UID/github-repo) - [6] Above Average - [Rate 6/10](https://docinsights.io/feedback/6/PROJECT_UID/github-repo) - [7] Very Good - [Rate 7/10](https://docinsights.io/feedback/7/PROJECT_UID/github-repo) - [8] Excellent - [Rate 8/10](https://docinsights.io/feedback/8/PROJECT-UID/github-repo) - [9] Outstanding - [Rate 9/10](https://docinsights.io/feedback/9/PROJECT_UID/github-repo) - [10] Perfect - [Rate 10/10](https://docinsights.io/feedback/10/PROJECT_UID/github-repo) **Note:** Replace `PROJECT-UID` with your actual project UID and `github-repo` with your repository name
Simple Rating Links
## Quick Rating Click a rating to provide feedback: [1/10](https://docinsights.io/feedback/1/PROJECT-UID/github-repo) | [2/10](https://docinsights.io/feedback/2/PROJECT-UID/github-repo) | [3/10](https://docinsights.io/feedback/3/PROJECT-UID/github-repo) | [4/10](https://docinsights.io/feedback/4/PROJECT-UID/github-repo) | [5/10](https://docinsights.io/feedback/5/PROJECT-UID/github-repo) | [6/10](https://docinsights.io/feedback/6/PROJECT-UID/github-repo) | [7/10](https://docinsights.io/feedback/7/PROJECT-UID/github-repo) | [8/10](https://docinsights.io/feedback/8/PROJECT-UID/github-repo) | [9/10](https://docinsights.io/feedback/9/PROJECT-UID/github-repo) | [10/10](https://docinsights.io/feedback/10/PROJECT-UID/github-repo) **Note:** Replace `PROJECT-UID` with your actual project UID and `github-repo` with your repository name
3. View Results
Monitor your feedback in the project dashboard:
- Total ratings and average scores
- Rating distribution charts
- Comment breakdown analysis
- Page URL distribution
- Individual rating details
Ready to Get Started?
Create your first project and start collecting feedback on your documentation.
Create Project