Skip to content

docs: link each Codacy skill to its SKILL.md on GitHub - #2747

Merged
claudiacodacy merged 1 commit into
masterfrom
docs/link-skills-to-github
Sep 9, 2026
Merged

docs: link each Codacy skill to its SKILL.md on GitHub#2747
claudiacodacy merged 1 commit into
masterfrom
docs/link-skills-to-github

Conversation

@claudiacodacy

Copy link
Copy Markdown
Contributor

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

  • Each skill in the Available skills table now links to its SKILL.md in codacy/codacy-skills (all six URLs verified against the repository).
  • Dropped the Needs column. It held "Both CLIs" on three of six rows, and it squeezed the Skill column enough that five of six skill names wrapped mid-token in the rendered table.
  • The per-skill CLI requirement moves to Requirements as one sentence, checked against the Prerequisites section of each upstream SKILL.md.

Verification

  • mkdocs build --strict exits 0, no warnings on this page.
  • vale docs/codacy-skills/index.md clean.
  • Rendered in a local preview at 1440px; compared the table against a description-list variant before settling on the table.

🤖 Generated with Claude Code

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>
@claudiacodacy
claudiacodacy requested a review from a team as a code owner September 9, 2026 13:47
@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Overall readability score: 53.95 (🟢 +0)

File Readability
index.md 66.82 (🔴 -0.57)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
index.md 66.82 49.41 8.48 10.1 11.48 7.04
  🔴 -0.57 🔴 -0.41 🔴 -0.07 🔴 -0.1 🔴 -0.24 🟢 +0.03

Averages:

  Readability FRE GF ARI CLI DCRS
Average 53.95 42.92 10.93 12.37 12.3 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

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.

@github-actions
github-actions Bot temporarily deployed to Netlify September 9, 2026 13:48 Inactive

@codacy-production codacy-production Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

@claudiacodacy
claudiacodacy merged commit adf7086 into master Sep 9, 2026
5 checks passed
@claudiacodacy
claudiacodacy deleted the docs/link-skills-to-github branch September 9, 2026 13:54
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>
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