Skip to content

docs: add new-navigation-banner to scan-fix-and-prevent classic pages (DOCT-2626 Phase B) - #1582

Merged
esabou-snyk merged 2 commits into
mainfrom
task/doct-2626-rollout-scan-fix-and-prevent
Sep 15, 2026
Merged

esabou-snyk merged 2 commits into
mainfrom
task/doct-2626-rollout-scan-fix-and-prevent

Conversation

@esabou-snyk

@esabou-snyk esabou-snyk commented Aug 3, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Adds {% include "<relative>/.gitbook/includes/new-navigation-banner.md" %} to every page in scan-fix-and-prevent/ whose frontmatter declares nav_context: classic. The include renders an info hint linking to Navigating Snyk (from PR #1577, merged).

Files changed: 262 — this is the largest of the five Phase B PRs.

Filter used

grep -l '^nav_context: classic$' scan-fix-and-prevent/**/*.md

Untouched:

  • Pages with nav_context: new or nav_context: agnostic.
  • Pages without a nav_context key.

Notes for reviewers

  • Every changed file has an identical two-line insertion (blank + include line + blank) immediately after the frontmatter's closing ---. Reviewing one file establishes the pattern for all 262.
  • Existing "Snyk 2.0 (Early Access)" hint blocks in manage-risk/dependencies-and-licenses/README.md, manage-risk/analytics/README.md, and manage-assets/manage-assets.md are on nav_context: new pages and therefore not touched by this PR — a separate cleanup, not a banner-rollout concern.

Test plan

  • GitBook preview renders the info-hint banner above the first heading on a spot-check of ~5 random affected pages across sub-sections (manage-risk, scan-with-snyk, snyk-platform-administration, manage-assets).
  • Link resolves to https://docs.snyk.io/getting-started/navigating-snyk.
  • git diff --stat matches the expected 262 files, exactly two-line insertion each.

Generated by Claude Code


Note

Low Risk
Documentation-only, repeated include insertion with no application or config changes.

Overview
This PR rolls out the shared new navigation GitBook banner across 262 scan-fix-and-prevent/ docs that use nav_context: classic.

Each page gets the same two-line change: {% include ".../.gitbook/includes/new-navigation-banner.md" %} inserted immediately after the YAML frontmatter (relative path depth varies by folder). No body copy or frontmatter keys are otherwise modified.

Pages with nav_context: new / agnostic or no nav_context are unchanged, including existing Snyk 2.0 hint blocks on some manage-risk pages.

Reviewed by Cursor Bugbot for commit 7c00c25. Bugbot is set up for automated code reviews on this repo. Configure here.

…ic pages (DOCT-2626 Phase B)

Prepends `{% include "<relative>/.gitbook/includes/new-navigation-banner.md" %}`
after the YAML frontmatter on every page in this section whose frontmatter
declares `nav_context: classic`.

Filter: `grep -l '^nav_context: classic$'` across the section.
Scope this PR: 262 files - the largest of the five rollout PRs.

Depends on the banner include file in main (PR #1577, merged).
@esabou-snyk
esabou-snyk requested a review from a team as a code owner August 3, 2026 13:23
@snyk-io

snyk-io Bot commented Aug 3, 2026 •

Copy link
Copy Markdown

✅ Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
✅ Open Source Security 0 0 0 0 0 issues
✅ Licenses 0 0 0 0 0 issues
✅ Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@cursor cursor Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The current head commit b131097 is reviewed.

Open in Web View Automation 

Sent by Cursor Automation: PR review for User Docs

…t-scan-fix-and-prevent

# Conflicts:
#	scan-fix-and-prevent/scan-with-snyk/snyk-api-web/configure-targets/configure-authentication/configure-basic-authentication.md
#	scan-fix-and-prevent/scan-with-snyk/snyk-api-web/configure-targets/verify-domain-ownership/verify-with-dns-txt.md

@cursor cursor Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 7c00c25. Configure here.

description: The components of each Snyk assets inventory layout
---

{% include "../.gitbook/includes/new-navigation-banner.md" %}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Wrong include path depth

Medium Severity

The banner include uses ../.gitbook/includes/new-navigation-banner.md, which resolves to fix/.gitbook rather than the space root at scan-fix-and-prevent/.gitbook. GitBook will not load the shared include on these pages, so the navigation banner is missing where this PR intends it.

Additional Locations (2)
Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 7c00c25. Configure here.

@esabou-snyk
esabou-snyk merged commit d2750db into main Sep 15, 2026
12 of 14 checks passed
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