Skip to content

docs(sca): Add Semgrep Malware Firewall beta page (hidden)#2713

Merged
amandadyson-semgrep merged 13 commits into
mainfrom
amanda/malware-firewall-beta
Jul 20, 2026
Merged

docs(sca): Add Semgrep Malware Firewall beta page (hidden)#2713
amandadyson-semgrep merged 13 commits into
mainfrom
amanda/malware-firewall-beta

Conversation

@amandadyson-semgrep

@amandadyson-semgrep amandadyson-semgrep commented Jul 16, 2026

Copy link
Copy Markdown
Collaborator

Summary

Adds a new (hidden) Supply Chain docs page for the Semgrep Malware Firewall, currently in private beta with customers starting 7/21.

  • Set with hidden: true so it is reachable only by direct link — excluded from the sidebar navigation, site search, sitemap, and AI indexing.
  • Placed under SCA (Supply Chain) → Malware detection and response so it inherits that section eyebrow above the title.
  • Page path: /semgrep-supply-chain/malware-firewall
  • File: docs/semgrep-supply-chain/malware-firewall.mdx

Content covers: overview, how it works, advisory/database sync, cooldowns, reporting, prerequisites, install & verify, testing, uninstall, troubleshooting, and related products (Guardian, AI-powered detection).

Draft / private beta — intentionally hidden from the main navigation. Opened as a draft primarily to surface the Mintlify rendered preview for review.

Verify

View the page at https://semgrep-ee9d73d8-amanda-malware-firewall-beta.mintlify.site/semgrep-supply-chain/malware-firewall

Please ensure:

  • A subject matter expert reviews the content
  • A technical writer reviews the PR
  • This change has no security implications or else you have pinged the security team
  • [NA] Any redirects are in docs/docs.json if URLs changed
  • [NA] If you edited docs/extensions/pre-commit.md.template.mdx, CI regenerates pre-commit.mdx on this PR (no manual run-build-scripts needed)
  • Check the Mintlify bot preview link on this PR (requires PR to main) - note that this requires navigating directly to https://semgrep-ee9d73d8-amanda-malware-firewall-beta.mintlify.site/semgrep-supply-chain/malware-firewall because the page is hidden

🤖 Generated with Claude Code

amandadyson-semgrep and others added 3 commits July 15, 2026 15:45
Add a new Supply Chain page documenting the Semgrep Malware Firewall,
placed under SCA (Supply Chain) > Malware detection and response so it
inherits that section eyebrow. The page sets hidden: true so it is
reachable only by direct link and is excluded from the sidebar and
search indexing while in private beta.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Remove the architecture diagram, generalize the malware-database rule
count to "continuously updated," and reword the incident-advisory bullet
to avoid overstating response time (no fixed SLO, framed around threat
identification).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Reword the request-cycle step to reflect that the firewall usually runs
mfw login automatically on install rather than the user signing in
manually.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
semgrep-docs 🟢 Ready View Preview Jul 16, 2026, 5:13 PM

The hidden: true frontmatter flag hides the page in local mintlify dev
but NOT on the hosted Mintlify build, where it still appears in the
sidebar. Remove the page from docs.json navigation instead, which
reliably keeps it link-only. hidden: true stays in the frontmatter for
search/sitemap/AI-index exclusion.

Trade-off: the page loses the "Malware detection and response" section
eyebrow above the title, which is derived from nav-group membership.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Point readers to the Malware firewall section of the Dashboard for
scanned and blocked dependency reporting.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Remove the AI-powered detection cross-link; it overlaps with in-flight
Workflows/AID work that isn't launched yet. Related products now
references only Semgrep Guardian.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Document the /install-mfw skill that ships with Semgrep Guardian, which
installs and configures the firewall automatically, alongside the manual
install script. Restructure Install and verify into tabs with a shared
verification step.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Sync docs/snippets/metrics.mdx with the current upstream
semgrep/semgrep metrics.md (adds semgrep install-semgrep-pro / Pro
Engine installation telemetry). Unblocks the Docs CI "Validate docs"
check, which regenerates this file and fails on any diff.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

@abhijna abhijna left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for creating this doc. I made some changes to wording and format.

Also, wanted to flag that semgrep-docs is a public repo. This page will be hidden on the docs site, but anyone looking through the GitHub repo will still be able to find it.

Comment thread docs/semgrep-supply-chain/malware-firewall.mdx Outdated

Copy link
Copy Markdown
Collaborator Author

Fair point. @kk what do you think?

Remove the "available only to customers participating in the private
beta" sentence from the top note.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@amandadyson-semgrep
amandadyson-semgrep merged commit 0550763 into main Jul 20, 2026
5 of 6 checks passed
@amandadyson-semgrep
amandadyson-semgrep deleted the amanda/malware-firewall-beta branch July 20, 2026 18:27
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.

4 participants