Skip to content

Conversation

@abhijna
Copy link
Collaborator

@abhijna abhijna commented Jan 22, 2026

To do:

  • 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'

@abhijna abhijna self-assigned this Jan 22, 2026
@abhijna abhijna added documentation Improvements or additions to documentation public-beta labels Jan 22, 2026
@abhijna abhijna marked this pull request as draft January 22, 2026 17:53
@netlify
Copy link

netlify bot commented Jan 22, 2026

Deploy Preview for semgrep-docs-prod ready!

Name Link
🔨 Latest commit 47f2769
🔍 Latest deploy log https://app.netlify.com/projects/semgrep-docs-prod/deploys/6972bb402450f900087dc268
😎 Deploy Preview https://deploy-preview-2471--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.

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 public-beta

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants