Skip to content

Conversation

@k80kent
Copy link
Collaborator

@k80kent k80kent commented Jan 17, 2026

Update from Go to JavaScript, add Gitlab, do some small cleanup

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'

Update from Go to JavaScript, add Gitlab, do some small cleanup
@netlify
Copy link

netlify bot commented Jan 17, 2026

Deploy Preview for semgrep-docs-prod ready!

Name Link
🔨 Latest commit c077ba6
🔍 Latest deploy log https://app.netlify.com/projects/semgrep-docs-prod/deploys/696ad7a9b01daa00075ab2cd
😎 Deploy Preview https://deploy-preview-2467--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.

@k80kent k80kent requested review from abhijna and khorne3 January 17, 2026 00:28
@k80kent
Copy link
Collaborator Author

k80kent commented Jan 17, 2026

Context for this PR is some feedback from Alexis: https://semgrepinc.slack.com/archives/C0370TA46PL/p1768606113247099

Copy link
Collaborator

@khorne3 khorne3 left a comment

Choose a reason for hiding this comment

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

Just some minor nits; otherwise, LGTM

### Supported SCMs

- GitHub Cloud
- Gitlab Cloud
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- Gitlab Cloud
- GitLab Cloud

- The **private** GitHub app for Semgrep installed.
- The app must have [**Read and write** access on the **Contents** permission](#grant-read-and-write-access-to-a-private-github-semgrep-app).
- Optionally: if you have [a private registry, connect it to Semgrep](#connect-a-private-registry-to-semgrep). Currently, Semgrep supports only private Python registries.
- The app must have [**Read and write** access on the **Contents** permission](#grant-read-and-write-access-to-a-private-github-semgrep-app) which current customers may need to manually enable.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- The app must have [**Read and write** access on the **Contents** permission](#grant-read-and-write-access-to-a-private-github-semgrep-app) which current customers may need to manually enable.
- The app must have [**Read and write** access on the **Contents** permission](#grant-read-and-write-access-to-a-private-github-semgrep-app). If you're a current customer, you must manually enable this if you haven't already.

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