docs: add new-navigation-banner to discover-snyk classic pages (DOCT-2626 Phase B, held) - #1596
Open
esabou-snyk wants to merge 1 commit into
Open
docs: add new-navigation-banner to discover-snyk classic pages (DOCT-2626 Phase B, held)#1596esabou-snyk wants to merge 1 commit into
esabou-snyk wants to merge 1 commit into
Conversation
…2626 Phase B, held)
Inserts {% include ".gitbook/includes/new-navigation-banner.md" %} on
the 39 discover-snyk pages whose frontmatter declares nav_context: classic.
Same diff as reverted PR #1579. This PR is intentionally held open (do
not merge) until the Navigating Snyk page lands on live docs at
https://docs.snyk.io/getting-started/navigating-snyk — otherwise the
banner points at a 404. Sequencing captured on DOCT-2626.
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
esabou-snyk
marked this pull request as ready for review
August 21, 2026 07:52
Contributor
There was a problem hiding this comment.
Staff tech writer review
No style or structural issues found.
Verified: all 39 include paths resolve arithmetically to discover-snyk/.gitbook/includes/new-navigation-banner.md · placement above the first H1 matches the standard include banner pattern · no existing content was altered or removed.
Sent by Cursor Automation: PR review for User Docs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Re-applies the exact 39-file diff from #1579 (which was reverted via #1595) so the work isn't lost. Inserts
{% include ".gitbook/includes/new-navigation-banner.md" %}on discover-snyk pages whose frontmatter declaresnav_context: classic.Opened as a draft, held on purpose. Do not merge until the sequencing below is resolved.
Why held
The banner links to
https://docs.snyk.io/getting-started/navigating-snyk, which currently returns 404 on live docs. The Navigating Snyk page is still an unmerged GitBook draft (CR #28). Shipping the banner before the target page lands sends users to a dead link.Merge sequence
docs.snyk.io/getting-started/navigating-snyk.snyk/design-content_docs, merge.Test plan
git diff main..task/doct-2626-rollout-discover-snyk-holdshows only additions of the{% include %}line across 39 discover-snyk files (same shape as docs: add new-navigation-banner to discover-snyk classic pages (DOCT-2626 Phase B) #1579 was).docs.snyk.io/getting-started/navigating-snykreturns 200 before this PR is marked ready.Tracked in DOCT-2626. Replaces reverted #1579.
Note
Low Risk
Documentation-only change adding a shared banner include; risk is the linked target page is currently 404, so merging before it is live would send users to a dead link.
Overview
Adds the
new-navigation-bannerGitBook include to 39discover-snykpages whose frontmatter declaresnav_context: classic. The include is inserted immediately after the frontmatter on each page, using a relative path to.gitbook/includes/new-navigation-banner.md.This is a held draft: the banner links to
docs.snyk.io/getting-started/navigating-snyk, which is not yet live. The PR should only be merged after that target page is published and returns 200.Reviewed by Cursor Bugbot for commit af46aa6. Bugbot is set up for automated code reviews on this repo. Configure here.