Skip to content

[TEC-521] Add instructions on re running sms checks#2489

Merged
abhijna merged 8 commits intomainfrom
abhijna/tec-521-add-instructions-on-re-running-sms-check
Feb 12, 2026
Merged

[TEC-521] Add instructions on re running sms checks#2489
abhijna merged 8 commits intomainfrom
abhijna/tec-521-add-instructions-on-re-running-sms-check

Conversation

@abhijna
Copy link
Collaborator

@abhijna abhijna commented Feb 9, 2026

Previews:

To do:

  • A subject matter expert (SME) reviews the content
  • A technical writer reviews the content or PR

Adding a new documentation page? Click to expand the checklist
  • Create .md or .mdx file in /docs/[section]/ with frontmatter: slug, title, description, displayed_sidebar, tags
  • Add page to appropriate sidebar in /sidebars.js (shows in side nav)
  • If adding the doc in a new directory: Update /src/theme/Navbar/Content/index.tsx → add path to getCurrentSection() (highlights top nav)

Sidebars fields for displayed_sidebar:
scanSidebar | rulewritingSidebar | devSidebar | learnSidebar | aboutSidebar | kbSidebar | whatsSemgrepSidebar

Top nav fields for getCurrentSection():
'scan' | 'write-rules' | 'learning-guides' | 'help' | 'explore'

@abhijna abhijna self-assigned this Feb 9, 2026
@abhijna abhijna added the documentation Improvements or additions to documentation label Feb 9, 2026
@netlify
Copy link

netlify bot commented Feb 9, 2026

Deploy Preview for semgrep-docs-prod ready!

Name Link
🔨 Latest commit dabc312
🔍 Latest deploy log https://app.netlify.com/projects/semgrep-docs-prod/deploys/698cec70fe843c00088ee7a7
😎 Deploy Preview https://deploy-preview-2489--semgrep-docs-prod.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Collaborator

@armchairlinguist armchairlinguist left a comment

Choose a reason for hiding this comment

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

Thanks for working on this! I had two broader approach questions after taking a look, only one minor note for the content itself:

  1. Can we clarify that when we talk about re-running scans, it's always in the context of diff-aware (PR/MR) scans? In particular I think the overview is not as clear about this. Full scans can be run with the button (and don't currently run on pushing new commits, although they may eventually, but even then the button would be preferred).
  2. Do we need this as a KB and on the overview, and if so, should the context be snippeted?

I'd be inclined to say we don't need it in both places, but I'm not opposed to it - just thinking that since it's so similar, maybe it'd be better to go ahead and snippet it now.

@abhijna
Copy link
Collaborator Author

abhijna commented Feb 11, 2026

Thanks for the great feedback, @armchairlinguist. I went ahead and snippeted it. Lmk what you think

Co-authored-by: Alexis Grant <alexis@semgrep.com>
@abhijna abhijna merged commit 1bc1489 into main Feb 12, 2026
8 checks passed
@abhijna abhijna deleted the abhijna/tec-521-add-instructions-on-re-running-sms-check branch February 12, 2026 16:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants