docs: unified summary; old docs / deprecations removals CF-2376#2626
docs: unified summary; old docs / deprecations removals CF-2376#2626manufacturist merged 4 commits intomasterfrom
Conversation
|
Overall readability score: 54.11 (🟢 +0.03)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
Up to standards ✅🟢 Issues
|
![codacy-production[bot]](https://avatars.githubusercontent.com/in/56611?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull Request Overview
The PR successfully implements the core requirements for unifying coverage and quality summaries and deprecating outdated documentation. However, there are structural inconsistencies that should be addressed before merging to ensure a truly 'unified' documentation experience. Specifically, the 'Issue summaries' section (lines 73-77) remains as a redundant block and should be merged into the main 'Pull request summary' section to avoid user confusion. Additionally, the frontmatter terminology needs a minor update to reflect the new feature name consistently.
About this PR
- The PR description is empty. Although the Jira ticket and title clarify the intent, please provide a brief summary of the changes in the description field for better visibility.
1 comment outside of the diff
docs/repositories-configure/integrations/github-integration.md
line 73-77🟡 MEDIUM RISK
The 'Issue summaries' section is redundant now that 'Pull request summary' (line 33) explicitly includes issues and metrics in its description (line 44). To complete the unification, remove this section and move the corresponding image to the primary 'Pull request summary' section.Try running the following prompt in your coding agent:
In
docs/repositories-configure/integrations/github-integration.md, remove the### Issue summariessection (lines 73-77) and move the image referenceto the end of the### Pull request summarysection (after line 44).
Test suggestions
- Verify 'AI-enhanced comments' section includes a note about GitHub deprecation.
- Verify the removal of the standalone 'Coverage summaries' section in GitHub integration docs.
- Verify the description of the unified summary includes quality gate, issues, metrics, and coverage details.
- Update troubleshooting guides to use the new 'pull request summary' terminology.
🗒️ Improve review quality by adding custom instructions
There was a problem hiding this comment.
Pull request overview
Updates Codacy documentation to reflect the GitHub integration UI/behavior changes around pull request summaries and AI features, removing deprecated GitHub-specific docs and aligning related troubleshooting/AI docs.
Changes:
- Renames/rewrites the GitHub “Pull request review” docs into “Pull request summary” and removes deprecated sections (Coverage summaries, AI-enhanced comments) from the GitHub integration page.
- Updates troubleshooting guidance to reference the new commenting surface.
- Updates Codacy AI docs to clarify AI-enhanced comments availability and adjusts AI Reviewer setup wording.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| docs/repositories-configure/integrations/github-integration.md | Renames/rewrites PR comment documentation and removes deprecated GitHub settings/sections. |
| docs/faq/troubleshooting/why-did-codacy-stop-commenting-on-pull-requests.md | Adjusts troubleshooting text to match updated GitHub commenting behavior. |
| docs/codacy-ai/codacy-ai.md | Clarifies AI-enhanced comments availability and updates AI Reviewer setup location text. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/faq/troubleshooting/why-did-codacy-stop-commenting-on-pull-requests.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (1)
docs/repositories-configure/integrations/github-integration.md:83
- With the removal of the Coverage summaries and AI-enhanced comments sections above, the images
github-integration-coverage-summary.pngandgithub-integration-ai-comment.pngappear to be unused across the docs now. Consider deleting these assets fromdocs/repositories-configure/integrations/images/(or re-linking them somewhere) to avoid keeping dead files in the repo.
### Suggested fixes {: id="suggest-fixes"}
{%
include-markdown "../../assets/includes/paid.md"
start="<!--paid-start-->"
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
👀 Live preview
🚧 To do