docs: add Codacy Skills section under Developer tools - #2745
Merged
Conversation
Codacy Skills was documented only as a section of the Codacy Cloud CLI page, which named one of the six skills that ship in codacy/codacy-skills. The other five were absent from the site, and setup-coverage was covered by an outbound link to a SKILL.md on GitHub. Add docs/codacy-skills/index.md as its own section in the Developer tools tab, listing every skill, which CLI it needs, and how to install the set on Claude Code, Claude.ai, Codex, Copilot, and Gemini CLI. The Cloud CLI page keeps its #install-the-codacy-skills anchor, reduced to a pointer, so inbound links from the product UI, blog, and support macros still resolve. Pages that linked to that anchor now link to the new page. Vendor document-text-outline for the sidebar, converted to explicit fill/stroke attributes since the theme does not ship the Ionicons CSS. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Contributor
Up to standards ✅🟢 Issues
|
Contributor
|
Overall readability score: 53.95 (🟢 +0.05)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
The section recorded a dated supersession and a table of the six skills that happened to ship. Both go stale: the count changes, and the date framing turns a standing decision into a changelog entry. State the rule instead — a family of skills spanning several tools does not nest under one of them — and keep the anchor constraint, which applies to any future move rather than to this one change. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The Vale check runs with filter_mode: added, and reviewdog exits non-zero on any result, so findings on new lines fail the build even though the action sets fail_on_error: false. - Register CLIs in the shared vocabulary. mkdocs.yml names the section "Codacy CLIs", so the plural is a repo term rather than a misspelling. - Wrap the codacy/codacy-skills repo slug in backticks. Inline code is an IgnoredScope, and the slug is a path rather than prose. - Reword three sentences that tripped Microsoft.Terms, .Contractions, and .Dashes. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
![codacy-production[bot]](https://avatars.githubusercontent.com/in/56611?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Pull Request Overview
The PR should address two merge-blocking documentation gaps: Codacy Skills update instructions do not cover GitHub Copilot or Gemini CLI, and the Codex installation commands can fail when destination directories do not exist. Codacy analysis is up to standards, with no automated coverage or quality findings reported.
Test suggestions
- Verify the new Codacy Skills page is registered in navigation after Codacy CLIs and renders with the configured sidebar icon.
- Verify the Skills page documents exactly six skills with their purposes and dependencies.
- Verify installation instructions exist for Claude Code, Claude.ai, Codex, Copilot, and Gemini CLI.
- Verify update instructions cover every supported assistant installation method.
- Verify the legacy Cloud CLI install anchor remains present and links to the new Skills page.
- Verify all migrated internal links and the coverage reporter tip resolve to the new page.
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Verify the new Codacy Skills page is registered in navigation after Codacy CLIs and renders with the configured sidebar icon.
2. Verify the Skills page documents exactly six skills with their purposes and dependencies.
3. Verify installation instructions exist for Claude Code, Claude.ai, Codex, Copilot, and Gemini CLI.
4. Verify update instructions cover every supported assistant installation method.
5. Verify the legacy Cloud CLI install anchor remains present and links to the new Skills page.
6. Verify all migrated internal links and the coverage reporter tip resolve to the new page.
Low confidence findings
- Add documentation validation covering navigation, anchors, internal links, and the documented installation and update procedures.
TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback
Contributor
There was a problem hiding this comment.
Pull Request Overview
No security or major logic issues were identified, and Codacy reports that the PR is up to standards. The remaining requirement-alignment issue concerns the legacy Cloud CLI section retaining executable installation commands instead of serving solely as a pointer to the new Skills page.
Test suggestions
- Verify the Codacy Skills page is present in
nav:after Codacy CLIs and appears in the Developer tools sidebar. - Verify the Skills page documents all six skills with their required tools and prerequisites.
- Verify each supported assistant has a working installation instruction, including Claude Code, Claude.ai, Codex, Copilot, and Gemini CLI.
- Verify update instructions cover every supported installation method.
- Verify the legacy Cloud CLI
#install-the-codacy-skillsanchor remains available and points readers to the new page. - Verify updated links from the Cloud CLI, Coverage Reporter, code-pattern configuration page, and Developer tools landing page resolve correctly.
- Verify the vendored sidebar icon renders with explicit fill/stroke attributes.
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Verify the Codacy Skills page is present in `nav:` after Codacy CLIs and appears in the Developer tools sidebar.
2. Verify the Skills page documents all six skills with their required tools and prerequisites.
3. Verify each supported assistant has a working installation instruction, including Claude Code, Claude.ai, Codex, Copilot, and Gemini CLI.
4. Verify update instructions cover every supported installation method.
5. Verify the legacy Cloud CLI `#install-the-codacy-skills` anchor remains available and points readers to the new page.
6. Verify updated links from the Cloud CLI, Coverage Reporter, code-pattern configuration page, and Developer tools landing page resolve correctly.
7. Verify the vendored sidebar icon renders with explicit fill/stroke attributes.
TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback
Two paragraphs were carrying detail the file does not need: the anchor constraint is already enforced by the heading in codacy-cloud-cli/index.md and by the general anchor rule in CLAUDE.md, and the list of questions the decision does not settle is not a decision. Leaves the entry the same length as its neighbours in this file. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Both Guardrails entries described the nav as it was before #2733, the same commit that created this file: they argued from a "(IDE Extension)" nav title that commit removed, and treated the move into Developer tools as a change still to be considered after it had been made. Keep what does not expire — Guardrails classifies as a developer tool however it is installed, its setup page must not be split across generic sections, and prominence is a positioning call rather than a structural one — and cut the snapshot around it. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
claudiacodacy
enabled auto-merge (squash)
September 9, 2026 12:01
The list covered three of the five install paths. Add the other two and reorder to match the install section. Copilot has no update mechanism: the install copies AGENTS.md into the reader's repository, so it goes stale silently and has to be re-downloaded and merged. Gemini CLI's command comes from its extensions reference, which also documents the restart. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
DMarinhoCodacy
approved these changes
Sep 9, 2026
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
2 participants
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.
Requested by marketing: a dedicated Codacy Skills section under Developer tools.
Why
Codacy Skills was documented only as one
##section of the Codacy Cloud CLI page. Six skills ship in codacy/codacy-skills; that section named one of them.setup-coveragewas documented by an outbound link to aSKILL.mdon GitHub, which takes the reader off the docs site.Only
codacy-cloud-cliactually wraps the Cloud CLI. Three of the six center on the Codacy Analysis CLI and two need no Cloud CLI at all, so filing them all under the Cloud CLI page misdescribed them.What changed
docs/codacy-skills/index.md, registered innav:as its own section in the Developer tools tab, after Codacy CLIs. Lists every skill and the CLI it needs, requirements, install steps for Claude Code, Claude.ai, Codex, Copilot, and Gemini CLI, and how to keep them updated.#install-the-codacy-skillsanchor, reduced to a pointer — inbound links from the product UI, blog, and support macros still resolve. Internal links now point at the new page.document-text-outlinevendored from Ionicons, converted to explicitfill/strokeattributes since the theme ships no Ionicons CSS. A straight copy from the npm package renders as a black blob..claude/reference/information-architecture.mdrecords the superseded decision that filed Skills under the Cloud CLI.Checks
mkdocs build --strictpasses aside from the git-revision-date warning on the then-uncommitted new file; that clears on this commit.nav:entry confirmed by hand — the strict build reports omissions at info level.CLIs, which isn't inaccept.txtdespitemkdocs.ymlnaming the section "Codacy CLIs". Left out of this diff since it changes linting repo-wide.Worth a look
release-notes/cloud/cloud-2026-02-migrating-semgrep.mdis on disk but missing fromnav:.