doc: Update the Segments setup instructions for Github#2641
Conversation
|
Overall readability score: 54.15 (🟢 +0)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
Up to standards ✅🟢 Issues
|
There was a problem hiding this comment.
Pull Request Overview
This documentation update correctly identifies and addresses the missing configuration step for GitHub Segments and clarifies support constraints for personal organizations. The PR meets quality standards and successfully covers the required acceptance criteria. Minor nitpicks regarding the capitalization of 'GitHub' and a trailing space should be resolved for branding consistency and clean formatting.
About this PR
- Ensure 'GitHub' is capitalized correctly throughout the documentation. The brand name is used as 'Github' in several places, which should be corrected to 'GitHub'.
TIP Improve review quality by adding custom instructions
TIP Let us know if you're enjoying the reviewer. Give us feedback
The Segments instructions were incomplete. There is an option that needs to be enabled on GH Segments, otherwise a "could not sync segments" warning will constantly appear on Codacy.
For more details on the problem, check this ticket: https://codacy.atlassian.net/browse/LK-2115