Skip to content

docs: fix links and the sidebar entry broken by the docs restructure - #2408

Merged
vdusek merged 6 commits into
v2from
docs/fix-v2-restructure-links
Nov 5, 2026
Merged

vdusek merged 6 commits into
v2from
docs/fix-v2-restructure-links

Conversation

@vdusek

@vdusek vdusek commented Nov 5, 2026 •

Copy link
Copy Markdown
Collaborator

Rebasing v2 onto master combined v2's changes with master's docs restructure (#2197). Four references ended up pointing at pages or ids that no longer exist, and the Docusaurus build fails on them:

  • website/sidebars.js lists concepts/storage-clients, which refactor(storages)!: rename storage clients to storage backends #2362 renamed to storage-backends. The build stops on the invalid sidebar id.
  • The Events concept page links enum/Event, but Event is a StrEnum in v2 (chore!: drop Python 3.10 support #2295), so its API page is class/Event.
  • The v1 upgrading guide links ../concepts/storage-clients.
  • The v2 upgrading guide links ../guides/proxy-management, ../guides/scaling-crawlers and ../guides/request-loaders, which now live under ../concepts/. The anchors they point at exist on the concept pages.
  • The Events and Configuration concept pages say that Snapshotter drives autoscaling and link its API page. In v2, Snapshotter is private and has no API page. The CPU and memory load signals listen to the system info events, and the crawler builds its default ConcurrencySystem from its configuration. The pages now say that and link those classes. The site build doesn't check API links, so it didn't flag these.

PR CI doesn't build the site, so only the docs release would catch these. With this change, pnpm build passes locally. The remaining broken-anchor warnings come from the frozen 0.6 API reference and from a Request#user_data link that master has too.

This should be merged before the logging stack (#2402–#2404). The CI part of the rebase fallout is in #2409.

✍️ Drafted by Claude Code

@vdusek vdusek added t-tooling Issues with this label are in the ownership of the tooling team. adhoc Ad-hoc unplanned task added during the sprint. labels Nov 5, 2026
@vdusek vdusek self-assigned this Nov 5, 2026
@codecov

codecov Bot commented Nov 5, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (v2@f46a104). Learn more about missing BASE report.

Additional details and impacted files
@@          Coverage Diff          @@
##             v2    #2408   +/-   ##
=====================================
  Coverage      ?   94.60%           
=====================================
  Files         ?      194           
  Lines         ?    14151           
  Branches      ?        0           
=====================================
  Hits          ?    13388           
  Misses        ?      763           
  Partials      ?        0           
Flag Coverage Δ
integration 77.34% <ø> (?)
unit 87.54% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@vdusek
vdusek merged commit cc65186 into v2 Nov 5, 2026
43 checks passed
@vdusek
vdusek deleted the docs/fix-v2-restructure-links branch November 5, 2026 19:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant