docs: Documentation analysis and improvement#766
Draft
github-actions[bot] wants to merge 1 commit intomainfrom
Draft
docs: Documentation analysis and improvement#766github-actions[bot] wants to merge 1 commit intomainfrom
github-actions[bot] wants to merge 1 commit intomainfrom
Conversation
Closes #765 Co-authored-by: Copilot <[email protected]>
5 tasks
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.
Closes #765
Summary of files analyzed
docs/workflows/security-scanning-ruleset.mddocs/workflows/gh-aw-security-detector.mdscripts/create-security-issues.shIssues found
docs/workflows/security-scanning-ruleset.md: The Severity Levels table documentedoblt-aw/severity/*labels as if emitted by detector output, but current runtime issue creation does not apply those labels.docs/workflows/security-scanning-ruleset.mdanddocs/workflows/gh-aw-security-detector.md: Label behavior was not fully synchronized, which could mislead readers about detector-created issue labels.Changes made
docs/workflows/security-scanning-ruleset.mdSeverity Levels table to reflect the current emitted label contract (oblt-aw/detector/security) for detector-created issues, to match observed runtime behavior.docs/workflows/security-scanning-ruleset.mdclarifying thatoblt-aw/severity/*labels are not currently emitted and that severity is represented in finding entries.docs/workflows/gh-aw-security-detector.mdusage section to explicitly state thatoblt-aw/severity/*labels are not emitted and to cross-link severity interpretation tosecurity-scanning-ruleset.md#severity-levels.What is this? | From workflow: Observability Agentic Workflow Entrypoint
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.