Skip to content

docs: lead security review with audit-first usage#1142

Draft
factory-nizar wants to merge 6 commits into
mainfrom
docs/security-review-first-class
Draft

docs: lead security review with audit-first usage#1142
factory-nizar wants to merge 6 commits into
mainfrom
docs/security-review-first-class

Conversation

@factory-nizar
Copy link
Copy Markdown
Contributor

Reorder docs/enterprise/security-review.mdx so the practical usage flows come right after the type cards, in the requested order: audit -> local diff -> GitHub CI.

Changes

  • After the PR security review / Full-codebase audit cards, jump straight into how to use it.
  • Run a full-codebase audit is now the lead section and recommends running it inside a Mission for the most thorough results, with single-session /security-review and @droid security --full as secondary options.
  • Run locally on a diff covers the CLI diff workflow.
  • Run in GitHub CI on pull requests covers @droid security and automatic_security_review.
  • Methodology, review pipeline, and severity levels moved below Configuration so they no longer block the how-to path.
  • Added a Missions link to the See also list.

Reorder the security review guide so the practical usage flows come
right after the type cards, in the order: full audit -> local diff ->
GitHub CI. Document the audit primarily as a Mission (/missions then
/security-review) for the most thorough results, with a periodic CI
schedule example using droid exec --mission. Methodology, review
pipeline, and severity levels move below configuration.

Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
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.

1 participant