Skip to content

doc: Update the Segments setup instructions for Github#2641

Merged
nfcodacy merged 2 commits intomasterfrom
LK-2118-update-the-docs-about-gh-segments
Apr 21, 2026
Merged

doc: Update the Segments setup instructions for Github#2641
nfcodacy merged 2 commits intomasterfrom
LK-2118-update-the-docs-about-gh-segments

Conversation

@nfcodacy
Copy link
Copy Markdown
Contributor

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

@nfcodacy nfcodacy requested a review from a team as a code owner April 20, 2026 15:39
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 20, 2026

Overall readability score: 54.15 (🟢 +0)

File Readability
segments.md 34.2 (🟢 +0.87)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
segments.md 34.2 21.13 14.59 17 14.05 8.23
  🟢 +0.87 🟢 +0.31 🟢 +0.19 🟢 +0.2 🟢 +0.05 🟢 +0.04

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54.15 43.03 10.93 12.31 12.23 8.02
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@codacy-production
Copy link
Copy Markdown
Contributor

codacy-production Bot commented Apr 20, 2026

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

AI Reviewer: first review requested successfully. AI can make mistakes. Always validate suggestions.

Run reviewer

TIP This summary will be updated as you push new changes. Give us feedback

Copy link
Copy Markdown
Contributor

@codacy-production codacy-production Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread docs/organizations/segments.md Outdated
Comment thread docs/organizations/segments.md Outdated
@github-actions github-actions Bot temporarily deployed to Netlify April 20, 2026 15:50 Inactive
Copy link
Copy Markdown
Contributor

@franciscoovazevedo franciscoovazevedo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@nfcodacy nfcodacy merged commit 1dac140 into master Apr 21, 2026
5 checks passed
@nfcodacy nfcodacy deleted the LK-2118-update-the-docs-about-gh-segments branch April 21, 2026 10:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants