docs: add Developer tools nav tab - #2733
Merged
Merged
Conversation
Adds the "Developer tools" nav tab proposal (API, Codacy Cloud CLI, IDE integrations, Guardrails) and the durable information-architecture decisions it depends on. The mkdocs.yml nav change itself is left as a reviewable diff in the plan, not applied. Also clarifies CLAUDE.md's IA hard rule: a reviewed proposal can be applied once explicitly confirmed, rather than only ever written up. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Applies the reviewed nav diff from .claude/plans/developer-tools-tab.md: moves Codacy API, Codacy Cloud CLI, IDE integrations, and Codacy Guardrails (renamed from "Codacy Guardrails (IDE Extension)") into a new top-level "Developer tools" tab, no file paths changed so no redirects needed. Adds a "Developer tools home" overview page linking to each tool, ordered Guardrails, API, Cloud CLI, IDE integrations per review feedback. Also drops the unmarked external "API v3/v2 reference" links from the sidebar under Codacy API since they read as internal pages; both URLs remain linked inline on that page's own "Endpoint documentation" table. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Reorders the Developer tools sidebar to Guardrails, API, Cloud CLI, IDE integrations. Renames "Developer tools home" to "Codacy dev tools" and "Integrating Codacy with your IDE" to "IDE integrations" so both fit on one line, and gives each its own icon (settings-outline, share-social- outline) instead of reusing home-outline or going without. Removes the unmarked external "API v3/v2 reference" links from the sidebar under Codacy API since they read as internal pages; both URLs stay linked inline on that page's own "Endpoint documentation" table. Adds "dev" to the Vale vocabulary, matching existing generic-term entries like "hotfix" and "onboarding". Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Contributor
|
Overall readability score: 53.79 (🟢 +0.06)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
Contributor
Up to standards ✅🟢 Issues
|
…rule The plan was committed in the same commit that added .claude/plans/ to .gitignore, so it kept showing up in every diff regardless of the rule -- .gitignore only affects untracked files. Untracking it here so it's a local-only scratch file like any future plan, per e98a811.
![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
While the 'Developer tools' navigation tab is correctly structured, the restructuring resulted in the removal of external links to API v2 and v3 technical specifications. Although this removal was identified as an acceptance criterion by the Intent agent, both the Code Review and Quality agents flag it as a significant regression for developer usability. Additionally, the new overview page introduces directory-style links that violate the link integrity standards defined in CLAUDE.md. Apart from these concerns, the PR is up to standards according to Codacy.
About this PR
- The relocation of 'Codacy Guardrails' is pending a marketing/visibility review. Please ensure this change is approved by the relevant stakeholders before merging.
Test suggestions
- Run 'mkdocs build --strict' to ensure structural and link integrity
- Verify navigation order in mkdocs.yml matches the specified sequence (Guardrails, API, Cloud CLI, IDE integrations)
- Ensure external API v2/v3 links are removed from the sidebar navigation
- Verify that links on the new overview page correctly target the moved documentation pages
TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback
claudiacodacy
enabled auto-merge (squash)
August 13, 2026 10:22
joanasteodoro
approved these changes
Aug 13, 2026
DMarinhoCodacy
approved these changes
Aug 13, 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
3 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.
Summary
docs/developer-tools/index.md) linking to each tool, ordered Guardrails, API, Cloud CLI, IDE integrations.Test plan
mkdocs build --strictpasses cleanvale docs/developer-tools/index.md— 0 issues.claude/plans/developer-tools-tab.md)🤖 Generated with Claude Code