Skip to content

docs: align Discover Snyk guides with the new navigation - #1923

Open
VeronicaSnyk wants to merge 6 commits into
mainfrom
docs/discover-snyk-new-nav-alignment
Open

VeronicaSnyk wants to merge 6 commits into
mainfrom
docs/discover-snyk-new-nav-alignment

Conversation

@VeronicaSnyk

@VeronicaSnyk VeronicaSnyk commented Oct 2, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Moves the Discover Snyk pilot guide and both implementation guides from classic-navigation instructions to the new navigation, and retires the classic banner on those pages.

  • 20 pages rewritten to new-navigation paths, retagged nav_context: new. Each procedure now starts from the scope selector, then a Settings path (for example, Settings > Security and access > Members).
  • 4 pages retagged agnostic with the banner removed: they describe the IDE, provision.snyk.io, or concepts, not app.snyk.io navigation (auto-provisioning-guide, local-scanning-with-the-ide, fix-a-vulnerability, name-your-organization).
  • Navigate the Snyk Web UI: scope selector rewritten as three segments (the Group segment is not always a dropdown, and All Organizations is the Group-scope label, not a dropdown item). SBOM removed from Inventory (only Container Images is live). Settings lists updated to match what the UI shows. Snyk Assist removed from the Organization Products and features list, because the page states Group Admins manage it.
  • SCM setup pages: fixed "GitHub" copy-paste errors on the GitLab, Azure DevOps, and Bitbucket pages, "Generate a GitHub PAT" on GitLab, and "BitBucket" spelling (including SUMMARY.md).

How the paths were verified

Doc Detective runs against app.snyk.io (new navigation on) in two Enterprise Tenants on October 2, 2026, plus the screenshot set from PR #1815. No Team plan account was checked.

Open questions: resolve before Ready

Six [ACTION REQUIRED] markers mark locations that could not be verified:

  1. How users switch Groups and enter Group scope (navigate-the-snyk-web-ui.md)
  2. Which plans show Your plan and billing and Available plans at Group scope (navigate-the-snyk-web-ui.md)
  3. Whether asset-discovery integrations moved from Inventory > Integrations to Settings > Integrations (connect-your-development-tools.md)
  4. Where a Team plan Organization shows its plan name (validate-your-snyk-plan.md)
  5. Where to purchase a Team plan (phase-2-configure-your-organization/README.md)
  6. Where license policies live (phase-2-configure-your-organization/README.md)

Not in this PR: screenshots

Image references are unchanged. Two of them are already replaced by #1815. Separately, the 21 lh7-rt.googleusercontent.com images on these pages return 403 to anyone not signed in to the Snyk Google Workspace, so customers most likely see broken images today. They need the originals exported or the screens recaptured in a follow-up.

Test plan

  • Review each changed page in the GitBook preview for discover-snyk
  • Resolve or remove all six [ACTION REQUIRED] markers
  • Spot-check the rewritten paths against app.snyk.io, including on a Team plan Organization

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only updates to navigation paths and front matter; no application or security logic changes.

Overview
Aligns Discover Snyk pilot, team, and enterprise implementation docs with the new Snyk Web UI navigation and drops the classic “new navigation” banner on those pages.

Most affected pages are retagged nav_context: new and rewrite click-paths to start from the scope selector, then Settings subtrees (for example Settings > Integrations > All integrations, Security and access > Members / SSO, Products and features for Code/IaC). Flows that are IDE-, provisioning-, or concept-only stay nav_context: agnostic with the banner removed.

Pilot SCM guides (GitHub, GitLab, Azure DevOps, Bitbucket) get numbered steps, corrected product names (Bitbucket spelling in SUMMARY.md), and fixes for wrong “GitHub” copy on GitLab/Azure/Bitbucket pages and “Generate a GitHub PAT” on GitLab. Import repositories, invite members, PR checks, scan coverage, and Snyk Essentials follow the same navigation pattern (e.g. Projects > Add projects instead of Dashboard Import projects).

Enterprise and team guides update the same paths for SSO, policies, org creation/cloning, imports, notifications, container/IaC toggles, and broker verification. navigate-the-snyk-web-ui.md describes the scope selector as three segments (All Organizations at Group scope), refreshes Group/Org Settings lists, and narrows Inventory to container images (SBOM removed from the description).

Image URLs are unchanged; behavior and screenshots are not part of this diff.

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

…w navigation

Rewrite 20 classic-navigation pages to the new-navigation paths verified
against app.snyk.io, retag 4 pages with no app navigation as agnostic, and
remove the classic banner from all 24. Correct the scope selector, Inventory,
and Settings lists in Navigate the Snyk Web UI, and fix GitHub copy-paste
errors and BitBucket spelling in the SCM setup pages. Unverified locations
carry [ACTION REQUIRED] markers.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@snyk-io

snyk-io Bot commented Oct 2, 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.

AI review

No style or structural issues found in the updated navigation procedures.

Verified: all 25 modified documentation pages across discover-snyk resolve on docs.snyk.io with HTTP 200 · navigation paths systematically align with the new navigation architecture defined in navigate-the-snyk-web-ui.md (top scope selector for Tenant, Group, and Organization; unified side menu; Settings hierarchy) · procedures are restructured into user-centric, numbered task flows from discovery and onboarding through implementation, adoption, and prevention · Snyk-defined nouns (Tenant, Group, Organization, Project) and UI elements (Settings, Integrations, All integrations, Projects) adhere to Snyk writing rules · [ACTION REQUIRED: ...] markers correctly isolate unresolved single-Group and Team-plan interface behaviors for review before merge.

The current head commit 8d669f9 is reviewed.

Open in Web View Automation 

Sent by Cursor Automation: PR review for User Docs

@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 8d669f9 is reviewed.

Open in Web View Automation 

Sent by Cursor Automation: PR review for User Docs

Removed outdated information regarding the classic path for integrations.
Removed unnecessary action requirement note regarding Team plan verification in the Snyk documentation.
Removed redundant instruction about confirming the new-navigation location for purchasing a Team plan.
@VeronicaSnyk
VeronicaSnyk marked this pull request as ready for review October 6, 2026 09:27
@VeronicaSnyk
VeronicaSnyk requested a review from a team as a code owner October 6, 2026 09: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.

1 participant