docs: sync recent features with the site and README#409
Merged
Conversation
Audit of v1.5.0–v1.8.2 user-visible features found several that shipped in code but were missing, thin, or inaccurate in the public docs. The existing doc gates only check that modes are mentioned and that docs->code references resolve, so code that lacked a doc mention was invisible to them. Close the gaps (EN and KO in parallel): - Web UI Upload step (Dependency-Track / TRUSCA) documented in ui.md and upload.md; previously the whole New-scan upload panel was undocumented. - Maven/Node scope pruning and its opt-outs BOMLENS_MAVEN_FULL_GRAPH / BOMLENS_NODE_FULL_GRAPH documented in ecosystems.md + docker-image env table. - Conformance spec-version overrides CYCLONEDX_SPEC_VERSIONS, AI_CYCLONEDX_SPEC_VERSIONS, SPDX_SPEC_VERSIONS documented in supplier-sbom.md + docker-image env table. - Fix reports.md: --all also implies --spdx (was "--notice --security"). - Reproducible output UI toggle documented; correct architecture.md that labelled --byte-stable "(CLI only)". - AI compliance profile card documented in ui.md; add the _ai-profile.* files to the artifacts inventory. - Add ENRICH_EOL and STALENESS_ENRICH to the docker-image env table. - Surface --ui --mount / SBOM_UI_MOUNT_DIR in no-cli.md and README.
haksungjang
added a commit
that referenced
this pull request
Jul 16, 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
1 participant
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.
Why
An audit of v1.5.0–v1.8.2 user-visible features against the public docs site and README found features that shipped in code but were missing, thin, or inaccurate in the docs. The existing doc gates only verify that scan modes are mentioned and that docs→code references resolve, so a new capability with no doc mention passes them unnoticed. This PR closes the content gaps; EN and KO are updated together.
Changes
High
ui.mdandupload.md. The whole New-scan upload panel (target, URL, token, TRUSCA project id) was undocumented.BOMLENS_MAVEN_FULL_GRAPH/BOMLENS_NODE_FULL_GRAPH: documented inecosystems.mdand thedocker-image.mdenv table.CYCLONEDX_SPEC_VERSIONS,AI_CYCLONEDX_SPEC_VERSIONS,SPDX_SPEC_VERSIONS: documented insupplier-sbom.mdand the env table (previously only in the site-excluded maintainers doc).Medium
reports.md:--allalso implies--spdx(was described as--notice --security, contradictingcli.mdand the actual behavior).ui.md; correctarchitecture.mdwhich labelled--byte-stable"(CLI only)".ui.md.Low
ENRICH_EOLandSTALENESS_ENRICHto thedocker-image.mdenv table._ai-profile.*files to the artifacts inventory.--ui --mount/SBOM_UI_MOUNT_DIRinno-cli.mdand the README.Verification
scripts/check-doc-coverage.sh— passtests/check-docs-drift.sh— pass (only the pre-existing stale-pin and i18n warnings remain, non-fatal)scripts/check-doc-links.sh— passmkdocs build --strict— passA follow-up PR will add a code→docs forward gate so an undocumented user-facing env var fails CI, which is the class of gap this audit surfaced.