Skip to content

docs: add new-navigation-banner to developer-tools classic pages (DOCT-2626 Phase B) - #1580

Merged
esabou-snyk merged 2 commits into
mainfrom
task/doct-2626-rollout-developer-tools
Sep 15, 2026
Merged

esabou-snyk merged 2 commits into
mainfrom
task/doct-2626-rollout-developer-tools

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 developer-tools/ whose frontmatter declares nav_context: classic. The include renders an info hint linking to Navigating Snyk (from PR #1577, merged).

Files changed: 113.

Filter used

grep -l '^nav_context: classic$' developer-tools/**/*.md

Untouched:

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

Test plan

  • GitBook preview renders the info-hint banner above the first heading on a spot-check of ~5 random affected pages.
  • Link resolves to https://docs.snyk.io/getting-started/navigating-snyk.
  • git diff --stat matches the expected 113 files, exactly two-line insertion each.

Generated by Claude Code


Note

Low Risk
Documentation-only, repeated include wiring with no product or auth logic changes.

Overview
Phase B (DOCT-2626) rolls the shared GitBook include new-navigation-banner.md onto 113 developer-tools/ pages that declare nav_context: classic, placing it immediately after the frontmatter and before the page title.

Each page gets the same two-line insertion: a blank line plus {% include "<relative>/.gitbook/includes/new-navigation-banner.md" %}, with the relative path adjusted for folder depth. Pages marked nav_context: new, agnostic, or without nav_context are unchanged.

Readers on classic developer-tools docs should see the standard info banner (linking to Navigating Snyk) above the first heading, consistent with other spaces that already use this include.

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

…ges (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: 113 files.

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:22
@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 ec19564 is reviewed.

Open in Web View Automation 

Sent by Cursor Automation: PR review for User Docs

…t-developer-tools

# Conflicts:
#	developer-tools/integrations/snyk-essentials-integrations-reference.md
@esabou-snyk
esabou-snyk merged commit ecc2c7a 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