docs: tweak docs site structure; documenting missing analyzers#8462
Merged
jeremylong merged 3 commits intodependency-check:mainfrom Apr 29, 2026
Merged
docs: tweak docs site structure; documenting missing analyzers#8462jeremylong merged 3 commits intodependency-check:mainfrom
jeremylong merged 3 commits intodependency-check:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Maven site navigation and analyzer documentation to improve docs discoverability and add missing analyzer pages.
Changes:
- Restructures the left-nav: promotes Remote Data Sources, renames “Modules” to “Components & Integrations”, and reorganizes analyzers into top-level + Augmenting/Experimental groupings.
- Updates existing docs pages/links to match the new structure (e.g., ISO scan page, OSS Index link, central/nexus docs cross-links).
- Adds new documentation pages for Artifactory, Yarn Audit, and PNPM Audit analyzers; removes the old OSS Index data-source stub page.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| src/site/site.xml | Reworks site menu structure, labels, and analyzer navigation entries. |
| src/site/markdown/general/scan_iso.md | Updates link text to match “Analyzers” naming. |
| src/site/markdown/data/ossindex.md | Removes OSS Index data-source stub page (now points users to analyzer docs elsewhere). |
| src/site/markdown/data/index.md | Fixes a typo and retargets OSS Index link to analyzer documentation. |
| src/site/markdown/components.md | Renames “Modules” page heading to “Components & Integrations”. |
| src/site/markdown/analyzers/yarn-audit.md | Adds Yarn audit analyzer documentation page. |
| src/site/markdown/analyzers/pnpm-audit.md | Adds PNPM audit analyzer documentation page. |
| src/site/markdown/analyzers/nexus-analyzer.md | Improves wording and adds cross-links/updated references. |
| src/site/markdown/analyzers/index.md | Splits analyzers into sections and adds PNPM/Yarn entries. |
| src/site/markdown/analyzers/central-analyzer.md | Adds explicit links to Nexus/Artifactory analyzer docs. |
| src/site/markdown/analyzers/artifactory-analyzer.md | Adds Artifactory analyzer documentation page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Also documents the Artifactory Analyzer. Signed-off-by: Chad Wilson <[email protected]>
Signed-off-by: Chad Wilson <[email protected]>
chadlwilson
force-pushed
the
tidy-site-structure
branch
from
1356464 to
2b67f89
Compare
Signed-off-by: Chad Wilson <[email protected]>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 11 out of 11 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Description of Change
This is a minor proposal - should treat suggestions as indicative.
Structure
Default view (general + data sources expanded)
Remote Data Sources
Components & Integrations
Analyzers
Analyzers Index
Missing docs
Related issues
N/A
Have test cases been added to cover the new functionality?
N/A