Skip to content

docs: reflect shipped SARIF output - #1369

Open
prx-my wants to merge 3 commits into
OWASP:mainfrom
prx-my:docs/fix-sarif-status
Open

prx-my wants to merge 3 commits into
OWASP:mainfrom
prx-my:docs/fix-sarif-status

Conversation

@prx-my

@prx-my prx-my commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

What changed and why

SARIF output shipped, but two docs pages still described it as unreleased:

  • website/docs/getting-started.md showed #cve-lite . --sarif (Coming soon)
  • website/docs/how-it-works.md said "SARIF output is planned" and linked to a now-404 issue in the old repository

This updates Getting Started to show --sarif as a supported command and rewrites the "Standards-based output" section to cover JSON, SARIF 2.1.0, and SBOM with links to the existing guides.

Closes #1374

@prx-my
prx-my requested a review from sonukapoor as a code owner October 21, 2026 19:26
Copilot AI balanced review requested due to automatic review settings October 21, 2026 19:26

Copilot AI 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.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@sonukapoor sonukapoor left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved.

Both pages were telling people a feature they can use today is still planned, and the issue the old sentence linked for progress has been closed for a long time, so the one thing a curious reader could click told them nothing. The replacement names the three flags and points at the format guides, which is what someone reading that section actually wants.

Worth knowing that this also clears the last pre-transfer repository link in the docs. Your #1370 fixes eleven of the twelve and the twelfth lives inside the sentence this PR deletes, so the two together leave none. I applied them on top of each other to check and they merge clean, but whichever of the two lands second will want a rebase since you touch the same file in both.

@prx-my
prx-my force-pushed the docs/fix-sarif-status branch from d879510 to df3de3e Compare October 22, 2026 09:00
@prx-my prx-my closed this Oct 22, 2026
@prx-my prx-my reopened this Oct 22, 2026

This branch has not been deployed

No deployments
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.

[Docs] SARIF output is documented as unreleased

3 participants