-
Notifications
You must be signed in to change notification settings - Fork 46
docs: add Developer tools nav tab #2733
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
e98a811
docs: propose Developer tools nav tab, record IA decisions
claudiacodacy 5e584b4
docs: apply Developer tools nav tab, add section overview page
claudiacodacy c4e70c9
docs: fix Developer tools sidebar icons, labels, and order
claudiacodacy 3340d29
exlude .claude plans
claudiacodacy 040ca25
docs: untrack developer-tools-tab.md, matching .claude/plans/ ignore …
claudiacodacy 3d1e171
switch VScode and IntelliJ
claudiacodacy 1c13f02
fix icon
claudiacodacy acede97
Merge branch 'master' into claude/developer-tools-tab-proposal
claudiacodacy File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # Information architecture decisions | ||
|
|
||
| Read this before proposing or evaluating a structural change. It records durable classification decisions so each new IA question doesn't get re-litigated from scratch. It is not a live map of the nav — for that, read `mkdocs.yml` per `docs-review-structure`. | ||
|
|
||
| ## Developer tools vs. everything else | ||
|
|
||
| The product is a developer tool by definition, so "for developers" doesn't separate anything on its own. The test that does: **where does the reader act from?** | ||
|
|
||
| - **Developer tools** = surfaces you install, run, or call from outside app.codacy.com — your terminal, your IDE, your CI pipeline, your AI agent's tool-calling layer. You write config or code against them. | ||
| - **Everything else** = surfaces you interact with inside app.codacy.com — dashboards, org settings, repo configuration, account management. You click through them. | ||
|
|
||
| By this test, "Developer tools" holds: the API, Codacy Cloud CLI, the IDE extensions (VS Code, IntelliJ), and Codacy Guardrails. Coverage Reporter technically qualifies (it's a CLI) but stays under "Configuring your repositories" — a deliberate exclusion made when this section was proposed, not a definitional one. Revisit deliberately if it comes up again; don't assume the exclusion still holds without asking. | ||
|
|
||
| ## Codacy AI vs. Developer tools | ||
|
|
||
| Both involve AI; the test is **who's calling whom**, not whether the word "AI" appears: | ||
|
|
||
| - **Codacy AI** = Codacy uses AI as an internal mechanism to produce something you review passively (AI-enhanced comments, Smart False Positive Triage, AI Reviewer). You're the consumer; the AI runs inside Codacy's own pipeline. | ||
| - **Developer tools, agent-facing side** = Codacy exposes a surface that *your* agent calls programmatically (Codacy MCP Server, Codacy Skills). You're the operator; Codacy is what gets called. | ||
|
|
||
| `organizations/ai-risk-hub.md` is neither bucket despite the name — it's governance over AI-generated code risk in the reader's own repositories, correctly filed under Organizations. | ||
|
|
||
| ## Why Codacy Guardrails counts as a developer tool, not just an IDE extension | ||
|
|
||
| The nav title "(IDE Extension)" on this section describes one delivery path, not the product. `codacy-guardrails-getting-started.md`'s "How to install - Manually" section sets up the identical capability — Analysis CLI, MCP Server, AI rules — with no IDE extension involved. Guardrails passes the direction-of-consumption test on its own terms, independent of how it's installed. | ||
|
|
||
| Guardrails interleaves CLI setup and MCP setup as one continuous flow inside a single page, in service of one outcome. Don't split that content to file separate pieces under generic "CLIs" or "MCP" sections — the split breaks the page's `#install-cli` / `#install-mcp-server` anchors for any inbound link outside this repo (product UI, blog, support macros), and there's no config-level fix for an anchor that moves to a different page. Move the whole section as one unit; don't extract from it. | ||
|
|
||
| ## Codacy Skills' home | ||
|
|
||
| Skills is a natural-language wrapper around Codacy Cloud CLI specifically, not general-purpose agent access to all of Codacy — the CLI's own page already frames it that way ("Pair it with Codacy Skills to interact with your Codacy data in plain language"). It belongs under Codacy Cloud CLI, not in a standalone agent-tools section. | ||
|
|
||
| ## A structural move can still be the wrong call for reasons outside IA | ||
|
|
||
| Guardrails currently sits prominently under "Getting started" with active marketing behind it (a blog-post CTA). Relocating it into "Developer tools" is IA-correct by the test above, but it's also a visibility change for a product someone may be actively driving signups to. That's a positioning call, not a structure call — flag it to whoever owns that placement rather than deciding it here. | ||
|
|
||
| ## See also | ||
|
|
||
| - [`docs-review-structure`](../skills/docs-review-structure/SKILL.md) — the general process this file's decisions feed into. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -31,6 +31,7 @@ dartanalyzer | |
| deadcode | ||
| Dependabot | ||
| detekt | ||
| dev | ||
| Dockerfile | ||
| endif | ||
| ESLint | ||
|
|
||
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| --- | ||
| description: Overview of how to use Codacy from outside the Codacy web app, through the API, Codacy Cloud CLI, IDE integrations, and Codacy Guardrails. | ||
| --- | ||
|
|
||
| # Codacy dev tools | ||
|
|
||
| Codacy also works from outside the Codacy web app: from your terminal, your IDE, or your AI agent's tool-calling layer. This page lists the tools available for each of those entry points. | ||
|
|
||
| <div class="content-columns-wrapper"> | ||
| <section class="content-link-column" aria-labelledby="dev-tools-options"> | ||
| <h2 id="dev-tools-options">Available tools</h2> | ||
|
|
||
| <a class="content-link" href="../codacy-guardrails/codacy-guardrails-getting-started/"> | ||
| <h3>Codacy Guardrails</h3> | ||
| <p>Scan AI-generated code for security and quality issues as it's written, and query your Codacy findings from your IDE's AI chat panel.</p> | ||
| </a> | ||
|
|
||
| <a class="content-link" href="../codacy-api/using-the-codacy-api/"> | ||
| <h3>Codacy API</h3> | ||
| <p>Retrieve and analyze your Codacy data, and make a few configuration changes, programmatically.</p> | ||
| </a> | ||
|
|
||
| <a class="content-link" href="../codacy-cloud-cli/"> | ||
| <h3>Codacy Cloud CLI</h3> | ||
| <p>Add repositories, review issues, and inspect pull requests from your terminal. Pair it with Codacy Skills to ask for the same in plain language from your AI assistant.</p> | ||
| </a> | ||
|
|
||
| <a class="content-link" href="../getting-started/integrating-codacy-with-visual-studio-code/"> | ||
| <h3>Visual Studio Code extension</h3> | ||
| <p>Review the Codacy analysis for a pull request without leaving your editor.</p> | ||
| </a> | ||
|
|
||
| <a class="content-link" href="../getting-started/integrating-codacy-with-intellij-ides/"> | ||
| <h3>IntelliJ plugin</h3> | ||
| <p>Review the Codacy analysis for a pull request from an IntelliJ-based IDE.</p> | ||
| </a> | ||
| </section> | ||
| </div> | ||
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.