docs: link each Codacy skill to its SKILL.md on GitHub - #2747
Merged
Conversation
Mark asked for each skill in the Available skills table to link to its source file so readers can read more about each one. Also simplify the table: the Needs column held "Both CLIs" on three of six rows and squeezed the Skill column enough to wrap the skill names, so the per-skill CLI requirement moves to Requirements as one sentence. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Contributor
|
Overall readability score: 53.95 (🟢 +0)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
Contributor
Up to standards ✅🟢 Issues
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
No merge-blocking issues were identified. Codacy reports the change as up to standards, with no new issues or coverage findings. The documentation build, Vale validation, and destination links remain unverified from the provided review data.
Test suggestions
- Verify all six skill links resolve to the correct upstream SKILL.md files.
- Verify the Available skills table contains only Skill and What it does columns.
- Verify the Requirements section accurately describes CLI and repository prerequisites for each skill.
- Run mkdocs build --strict and Vale against the updated page.
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Verify all six skill links resolve to the correct upstream SKILL.md files.
2. Verify the Available skills table contains only Skill and What it does columns.
3. Verify the Requirements section accurately describes CLI and repository prerequisites for each skill.
4. Run mkdocs build --strict and Vale against the updated page.
Low confidence findings
- Please run and record link verification,
mkdocs build --strict, and Vale validation for the updated documentation page.
TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback
DMarinhoCodacy
approved these changes
Sep 9, 2026
claudiacodacy
added a commit
that referenced
this pull request
Sep 10, 2026
Brings in #2747 (link each Codacy skill to its SKILL.md) and #2748 (update the Guardrails built-in scanner lists). One conflict, in docs/codacy-skills/index.md. #2747 removed the "Needs" column from the Available skills table and moved the per-skill CLI requirement into a sentence under Requirements, which is the column this branch had added the two CLI page links to. Resolved by taking that commit's table as-is and moving the links to the sentence the information moved to, so both changes survive: the skill names link to their SKILL.md, and the two CLI names link to their documentation. docs/codacy-guardrails/codacy-guardrails-getting-started.md merged without conflict — #2748 rewrote the scanner lists above the two lines this branch changed. Verified the merged file is that commit's version plus only those two link edits, with all 30 scanner entries intact. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Feedback from Mark on the new Codacy Skills page: link each skill to its file on GitHub so readers can read more about each one.
Changes
SKILL.mdincodacy/codacy-skills(all six URLs verified against the repository).Prerequisitessection of each upstreamSKILL.md.Verification
mkdocs build --strictexits 0, no warnings on this page.vale docs/codacy-skills/index.mdclean.🤖 Generated with Claude Code