Visual Review Tools Docs improvements
Problem to solve
The Documentation for Visual Review Tools is missing some things that would make using this feature easier and add context.
- What problem does this solve for the user?
- How does this feature work?
- What are the prerequisites for using it?
- Example project that walks through setup
- clarify why MR ID would be wanted / needed and how to set it up through an environment variable
Further details
Some of these suggestions came from suggestions in a UX review and our own experience trying to use the feature/docs.
Proposal
- Add a use case for using the feature (why MR ID is nice, why auth is nice)
- Clean up the example of code to add, it's incorrect compared to what is live today
- Stretch Link to a sample GitLab project so users can see this in action / see how it is setup.
Who can address the issue
- Anyone on Testing and/or has used the Visual Reviews feature.
Other links/references
Edited by James Heimbuck