-
Notifications
You must be signed in to change notification settings - Fork 239
[DOCS] Add structured output caveats to AI summary guide #870
Copy link
Copy link
Closed
Labels
area:docsDocumentation or contributor guide workDocumentation or contributor guide worklevel:beginner20 pts difficulty label for small beginner-friendly PRs20 pts difficulty label for small beginner-friendly PRspriority:mediumImportant issue with normal urgencyImportant issue with normal urgencytype:docsDocumentation work category bonus labelDocumentation work category bonus label
Description
Activity
Metadata
Metadata
Assignees
Labels
area:docsDocumentation or contributor guide workDocumentation or contributor guide worklevel:beginner20 pts difficulty label for small beginner-friendly PRs20 pts difficulty label for small beginner-friendly PRspriority:mediumImportant issue with normal urgencyImportant issue with normal urgencytype:docsDocumentation work category bonus labelDocumentation work category bonus label
Summary
AI summary docs should explain how structured output expectations differ from free-form summaries.
Problem
The current documentation is either missing a critical explanation, outdated, or fragmented across too many places.
Where to update
docs/AI_SUMMARY.md, backend/secuscan/ai_summary.pyExpected outcome
A contributor should be able to complete this update with a focused documentation PR and leave the surrounding docs easier to follow.
Acceptance criteria
Verification
Review the changed docs against the current code paths or scripts they describe and spot-check any commands or file references.
Additional context
Prefer precise edits over broad rewrites unless the referenced section is already structurally broken.