Skip to content

docs: reconcile PR edits from 6-9 Oct with GitBook's restructure - #1948

Merged
VeronicaSnyk merged 1 commit into
mainfrom
docs/reconcile-oct-6-to-9
Oct 9, 2026
Merged

VeronicaSnyk merged 1 commit into
mainfrom
docs/reconcile-oct-6-to-9

Conversation

@VeronicaSnyk

@VeronicaSnyk VeronicaSnyk commented Oct 9, 2026 •

Copy link
Copy Markdown
Collaborator

Why

GitBook change requests #22, #43, #5 and #20 merged while Git Sync was paused. They moved 520 pages into new folders named after the navigation headings. When sync resumed, GitBook wrote every page to its new path but left the old files in place, and wrote its own 6 Oct copy over pages edited on public since then.

Result on main today: 59 of the 62 files changed by PRs since 6 Oct aren't on the live site. They're overwritten (for example remediation-agent.md from #1844, fix.md from DOCT-2783), reverted to 6 Oct (#1944, supported-languages pages), or stranded on old paths the navigation no longer uses (pilot guide work from #1899, #1923, #1925). There are also 520 orphaned pages that nothing links to.

What this PR does

  • Keeps GitBook's new structure. The navigation is unchanged and matches what's live.
  • Restores the PR edits onto the new paths. Each page is a three-way merge: the base is the page on 6 Oct, one side is the PR edits, the other is today's GitBook content. Conflicts were resolved in favor of the PR edits, after checking that every GitBook-only line that was dropped is either a formatting change or has an equivalent on the page. All 438 lines added by the PRs are present.
  • Deletes the 520 orphaned old copies. 484 were untouched 6 Oct copies and 36 held PR edits that are now on the new paths. None contain unique content.
  • Repoints three relative links broken by the move.
  • Updates automation paths in merge-compatibility-matrix.sh, sync-error-catalog.yml and AGENTS.md.

Checks

6 Oct main now This PR
Pages on disk 1312 1832 1312
Broken relative links 4 4 4 (same ones as 6 Oct)
Conflict markers 0 0 0

Review focus

  • Pages where both sides changed: scan-fix-and-prevent/fix/remediation-agent.md, scan-fix-and-prevent/fix/fix.md, discover-snyk/navigate-the-snyk-web-ui.md, discover-snyk/SUMMARY.md and the pilot guide pages under discover-snyk/implementation-guides/.
  • Merging publishes immediately through Git Sync.

Follow-ups

  • snyk/snyk-ls update-compatibility-matrix.yaml still copies the matrix to developer-tools/snyk-ide-plugins-and-extensions/. It needs to target developer-tools/integrations/snyk-ide-plugins-and-extensions/, or its daily PRs will stop for manual review.
  • snyk/user-docs-internal needs the same reconciliation and automation path updates.

🤖 Generated with Claude Code


Note

Medium Risk
Large-scale doc moves and deletions can drop or misplace content and break links; automation path updates must stay in sync with upstream jobs (e.g. snyk-ls matrix workflow) or sync PRs will fail.

Overview
Reconciles GitBook’s navigation restructure with documentation edits that landed on main while sync was paused. Removes hundreds of orphaned pages still sitting on pre-restructure paths (for example old developer-tools/scm-integrations/, developer-tools/scan-with-snyk/snyk-tools/, and related trees) so the repo matches the live nav and duplicate 6 Oct copies are gone.

Restores contributor/PR changes on the new folder layout (per the PR description’s three-way merge); the diff also shows automation and contributor docs aligned to moved assets: MATRIX_PATH in merge-compatibility-matrix.sh, ERROR_CATALOG_DOCS_FILE_REMOTE in sync-error-catalog.yml, and the generated-path table in AGENTS.md now point at developer-tools/integrations/.../compatibility-matrix.md and scan-fix-and-prevent/prevent/error-catalog.md. The IDE compatibility matrix at the new path is refreshed (CLI upper bounds and table formatting). A small AWS Lambda webhook guide change drops an embedded figure in favor of continuing the setup steps.

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

GitBook change requests #22, #43, #5 and #20 merged while Git Sync was
paused and moved 520 pages into new folders. When sync resumed, GitBook
wrote the new paths, left the old files in place, and overwrote or
reverted most PR edits merged on public since 6 Oct.

- Three-way merge (base 6 Oct, PR edits, GitBook now) of every PR edit
  onto the page's new path; all 438 PR-added lines are present
- Delete the 520 orphaned old copies (no unique content)
- Repoint three relative links broken by the move
- Point the IDE compatibility matrix merge script, the error catalog
  sync and AGENTS.md at the new paths

Co-Authored-By: Claude Opus 5.5 <[email protected]>
@snyk-io

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

@VeronicaSnyk
VeronicaSnyk marked this pull request as ready for review October 9, 2026 13:07
@VeronicaSnyk
VeronicaSnyk requested review from a team as code owners October 9, 2026 13:07
@VeronicaSnyk
VeronicaSnyk merged commit 84b65aa into main Oct 9, 2026
20 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.

2 participants