Skip to content

Conversation

@j12y
Copy link
Collaborator

@j12y j12y commented Dec 2, 2025

Thanks for improving Semgrep Docs 😀

Please ensure

  • A subject matter expert (SME) reviews the content
  • A technical writer reviews the content or PR
  • This change has no security implications or else you have pinged the security team
  • Redirects are added if the PR changes page URLs
  • If you have changed any header tag links (doc/#this-kind-of-anchor), update all instances of that link

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'

@netlify
Copy link

netlify bot commented Dec 2, 2025

Don't forget to add /docs at the end of the deploy preview site URL!

Name Link
🔨 Latest commit 13b2a33
🔍 Latest deploy log https://app.netlify.com/projects/semgrep-docs-prod/deploys/692e2d9c6924070008f2a90a
😎 Deploy Preview https://deploy-preview-2416--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.

@khorne3 khorne3 merged commit ab12727 into main Dec 2, 2025
10 checks passed
@khorne3 khorne3 deleted the j12y/https branch December 2, 2025 14:45
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.

3 participants