Skip to content

docs: reorganize supported languages and tools by scan type - #2731

Merged
claudiacodacy merged 8 commits into
masterfrom
docs-supported-languages-scan-type-toc
Aug 12, 2026
Merged

docs: reorganize supported languages and tools by scan type#2731
claudiacodacy merged 8 commits into
masterfrom
docs-supported-languages-scan-type-toc

Conversation

@claudiacodacy

@claudiacodacy claudiacodacy commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Replaces the single 10-column, ~50-row table on Supported languages and tools with an Overview table (Language | File extensions | Supported scans, each scan name linking to its section) followed by one section per scan type, so a language lookup and a category lookup both work from this page.
  • Section order: Overview, Static analysis, Secret detection, Dependency vulnerability scanning, Malicious packages detection, License scanning, Suggested fixes, Duplication, Complexity, Docker images of supported tools.
  • Switched the page's footnotes from hand-rolled <sup><a>...</a></sup> HTML (unstyled anywhere in the theme, and its bottom-of-page list read oddly) to the footnotes markdown extension ([^id] / [^id]: text), which Material renders as proper numbered, back-linkable footnotes. Enabled footnotes in mkdocs.yml — confirmed via repo-wide grep that no page currently uses [^...] syntax, so this is additive, not a behavior change elsewhere.
  • Converted the "Docker images of supported tools" table from raw HTML to a markdown table — required for its footnote references to render as real footnotes (raw HTML blocks aren't reprocessed for markdown inline syntax).
  • Removed forced <br> line breaks in the Dependency vulnerability scanning and Malicious packages detection tables — leftover from when these were columns in a 10-column table and needed to wrap narrowly; they read as broken mid-sentence wraps in the new, wider 2-column layout.
  • Left a <!-- TODO --> marker on Complexity: the table currently lists a per-language tool (Lizard, detekt), but Codacy also calculates a separate file-level complexity metric, and there's no documented per-language breakdown of that metric to model the distinction — flagging rather than guessing.
  • Fixed relative links to the "which metrics does Codacy calculate" page (were copied from a raw-HTML href with a directory-style path that doesn't apply to a markdown link).
  • Suggested fixes, Duplication, and Complexity are now top-level ## sections (no "Others" wrapper) so they show up directly in the page's on-page TOC.
  • Stacked multi-value file extensions in the Overview table with <br> (e.g. C++'s five extensions each on their own line) instead of one long comma-separated string, so the column reads narrower.
  • Fixed a broken Prospector link in "Docker images of supported tools": it pointed to landscapeio/prospector2, an unrelated repo, instead of landscapeio/prospector (already used correctly twice elsewhere on the page).

Theme fixes (theme/stylesheets/content.css)

  • Enlarged the tap target on footnote-marker links, which inherit sup's browser-default font-size: smaller and had no styling anywhere in the theme (~5×15px clickable area). Rule covers both the footnotes extension's <sup><a> markup and the hand-rolled <a><sup> pattern still used on a couple of other pages.
  • Fixed a real rendering bug surfaced by switching to real footnotes: a footnote referenced from many rows (e.g. the "opengrep" footnote, used by ~20 languages) gets one back-reference link per usage, and Material renders those one per line instead of flowing inline — turning a heavily-referenced footnote into a list item ~1150px tall. Now only the first back-link renders; confirmed footnote list items are back to normal single/few-line heights.

Test plan

  • mkdocs build --strict passes (anchor validation is warn→error under --strict, confirming every footnote and Overview jump-link resolves)
  • vale docs/getting-started/supported-languages-and-tools.md — 0 errors/warnings/suggestions
  • Confirmed the H1 anchor and #docker-images-of-supported-tools — both referenced by inbound links/redirects elsewhere in the repo — are unchanged and present in the built HTML
  • TOC now reads: Overview, Static analysis, Secret detection, Dependency vulnerability scanning, Malicious packages detection, License scanning, Suggested fixes, Duplication, Complexity, Docker images of supported tools, See also
  • Footnote list confirmed rendering as a real <ol> with back-references; item height back to ~17px (was ~1150px) after the backref fix, verified across all 10 footnotes
  • Footnote-marker tap target confirmed on the new <sup><a> markup (~15×22px) and spot-checked on the pre-existing <a><sup> pattern on managing-security-and-risk.md and organization-overview.md
  • Spot-checked several category tables against the original table data for transcription accuracy
  • Verified landscapeio/prospector2 resolves to a real but unrelated repo, and landscapeio/prospector is the correct, already-used-elsewhere link

🤖 Generated with Claude Code

Replace the single 10-column, 50-row table with one section per scan
type (static analysis, secret detection, dependency vulnerability
scanning, etc.), each holding a narrow language-to-tool table. The
page's TOC now lists 9 scan types instead of forcing readers to
scroll a table that ran off-screen horizontally.
@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 commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Overall readability score: 53.74 (🔴 -0.16)

File Readability
supported-languages-and-tools.md 7.84 (🔴 -41.3)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
supported-languages-and-tools.md 7.84 0 19 22 19 8.56
  🔴 -41.3 🔴 -31.17 🔴 -8.19 🔴 -8.9 🔴 -4.8 🔴 -0.75

Averages:

  Readability FRE GF ARI CLI DCRS
Average 53.74 42.79 10.97 12.4 12.31 8.03
  🔴 -0.16 🔴 -0.12 🔴 -0.03 🔴 -0.03 🔴 -0.02 🟢 +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

<sup> inherits font-size: smaller with no custom styling anywhere in
the theme, so footnote links like <a href="#opengrep"><sup>1</sup></a>
render a ~5x15px clickable area. Pad the sup and pull back with a
matching negative margin so the hit area grows without shifting
surrounding text or the visible marker size.
@github-actions
github-actions Bot temporarily deployed to Netlify August 12, 2026 12:56 Inactive
claudiacodacy and others added 2 commits August 12, 2026 14:32
- Enable the footnotes markdown extension so [^id] renders as proper
  numbered, back-linkable footnotes instead of hand-rolled
  <sup><a>...</a></sup> HTML with no theme styling.
- Add an Overview section (Language | File extensions | Supported
  scans / Others) ahead of the scan-type sections, with each scan
  name linking to its section, so a language lookup and a
  category lookup both work from this page.
- Reorder sections: Overview, Static analysis, Secret detection,
  Dependency vulnerability scanning, Malicious packages detection,
  License scanning, Others (Suggested fixes, Duplication, Complexity),
  Docker images of supported tools.
- Convert the Docker images tool-to-repository table from raw HTML to
  a markdown table, needed for its footnote references to render.
- Drop forced <br> line breaks in the Dependency vulnerability
  scanning and Malicious packages detection tables — leftover from
  when these were columns in a 10-column table and needed to wrap
  narrowly; they read as broken mid-sentence wraps in the new,
  wider 2-column layout.
- Flag with a TODO that Complexity may conflate a per-language tool
  (what's listed) with a separate file-level metric Codacy also
  calculates; no documented per-language breakdown of the metric
  exists yet to model that split.

Theme: a footnote referenced from many rows (e.g. the "opengrep"
footnote, used by ~20 languages) gets one back-reference link per
usage. Material renders those one per line instead of flowing inline,
turning a heavily-referenced footnote into a list item several
screens tall. Keep only the first back-link. Also extend the sup
tap-target fix to cover both the footnotes extension's <sup><a>
markup and the hand-rolled <a><sup> pattern still used on other pages.
- Drop per-row #suggest-fixes anchor links left dangling after the
  footnote/section rework — htmltest flagged 11 broken hashes since the
  anchor they used to jump to no longer exists on the page.
- Wrap file extensions in the new Overview table as code spans, and the
  literal github.com domain reference as code, so Vale's Terms rule
  stops matching them as miscapitalized product names.
- Fix "Agentlinter" -> "AgentLinter" to match the tool's actual name
  used elsewhere on the same page.
- Add SQLFluff, pipenv, Bundler, and lockfile to the Vale vocabulary —
  pre-existing terms that were dormant because reviewdog only lints
  added lines, and this page's whole table just became "added".

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions
github-actions Bot temporarily deployed to Netlify August 12, 2026 13:47 Inactive
Promotes Suggested fixes, Duplication, and Complexity to top-level
sections so they show up in the page's on-page TOC, and stacks
multi-value file extensions with <br> instead of a long
comma-separated list.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@claudiacodacy
claudiacodacy marked this pull request as ready for review August 12, 2026 14:07
@claudiacodacy
claudiacodacy requested a review from a team as a code owner August 12, 2026 14:07
@github-actions
github-actions Bot temporarily deployed to Netlify August 12, 2026 14:07 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

The PR successfully reorganizes the 'Supported languages and tools' documentation by scan type and modernizes the underlying structure using native Markdown footnotes. Codacy analysis indicates the changes are up to standards, and the CSS improvements for footnote tap targets enhance mobile accessibility.

There is a notable implementation gap: the PR description mentions an 'Others' section containing 'Suggested fixes', 'Duplication', and 'Complexity', but the current implementation uses individual H2 headers for these categories without a parent 'Others' header. Additionally, a high-severity issue was identified regarding a broken link for the Prospector tool that must be corrected before merging.

About this PR

  • The PR implementation uses individual H2 headers for 'Suggested fixes', 'Duplication', and 'Complexity'. This contradicts the PR description and test plan which specified these should be grouped under an 'Others' section. Please align the header hierarchy with the intended TOC structure.

Test suggestions

  • Found recommended test scenario: Verify that Overview table links correctly anchor to their respective scan-type headers.
  • Found recommended test scenario: Verify that the 'footnotes' extension is enabled and rendering proper back-links in the build.
  • Found recommended test scenario: Verify that footnote markers have an enlarged tap target (padding) as specified in CSS.
  • Found recommended test scenario: Verify that footnotes with multiple references only display a single back-reference link to prevent layout bloat.
  • Found recommended test scenario: Verify that relative links to ../faq/code-analysis/which-metrics-does-codacy-calculate.md are valid and resolve correctly.

TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback

Comment thread docs/getting-started/supported-languages-and-tools.md Outdated
Comment thread theme/stylesheets/content.css
Comment thread docs/getting-started/supported-languages-and-tools.md
@claudiacodacy
claudiacodacy enabled auto-merge (squash) August 12, 2026 14:51
claudiacodacy and others added 2 commits August 12, 2026 15:51
…managers

Prospector pointed to landscapeio/prospector2, an unrelated repo, instead
of landscapeio/prospector (already correct elsewhere on the page) —
caught by AI PR review. Also renames the License scanning table's "Tools"
header to "Package managers" since it lists Conan, NuGet, npm, etc.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@claudiacodacy
claudiacodacy disabled auto-merge August 12, 2026 14:56
@claudiacodacy
claudiacodacy enabled auto-merge (squash) August 12, 2026 14:56
@github-actions
github-actions Bot temporarily deployed to Netlify August 12, 2026 14:59 Inactive
@claudiacodacy
claudiacodacy merged commit d6f4556 into master Aug 12, 2026
5 checks passed
@claudiacodacy
claudiacodacy deleted the docs-supported-languages-scan-type-toc branch August 12, 2026 14:59
claudiacodacy added a commit that referenced this pull request Aug 12, 2026
* docs: reorganize roles and permissions by Codacy role

Splits the three wide GitHub/GitLab/Bitbucket permission grids (up to
10 columns each) into short per-provider role-mapping lists plus one
shared set of narrow Operation|Allowed tables per Codacy role. The
same permission values were being repeated identically across all
three provider tables; this states each fact once instead of three
times and removes the horizontal scroll. Follow-up to #2731, which did
the analogous reorg for supported-languages-and-tools.md.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* docs: merge per-role permission tables into one comparison matrix

The five separate Operation|Allowed tables made it hard to compare
roles side by side, which is the more common use case (an admin
deciding what role to assign) than looking up a single role. Replaces
them with one table (Operation rows x 5 Codacy-role columns) so all
roles are visible at once, still narrower than the original per-provider
tables. Anchors for each role are preserved via id attributes on the
table header cells.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* docs: use tables for the Git provider role mappings

Bulleted lists forced a comma-separated set of provider roles into a
bolded "term," which is an awkward fit for a plain role-to-role
mapping. A two-column table (Git provider role | Codacy role) is the
more direct container for that comparison.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* docs: scope the GitHub App footnote to GitHub

The footnote on "Add and remove repository" only existed on the
original GitHub table; GitLab and Bitbucket's identical Yes had no
such caveat. Merging the three provider tables into one shared
Repository admin column left the footnote attached to a value
GitLab/Bitbucket readers also see, so make the scope explicit rather
than let it read as a cross-provider requirement.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* fix: correct table border CSS comment and include th in border rules

The comment said borders were "disabled" for horizontal lines when the
rule actually adds them via border-top. th was also missing from the
selector, so header cells lacked the vertical dividers body cells get.

Addresses Codacy AI review feedback on #2732.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 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