Skip to content

docs: add documentation versioning support#1815

Open
vdusek wants to merge 2 commits intomasterfrom
docs/remove-stale-js-sdk-version-links
Open

docs: add documentation versioning support#1815
vdusek wants to merge 2 commits intomasterfrom
docs/remove-stale-js-sdk-version-links

Conversation

@vdusek
Copy link
Copy Markdown
Collaborator

@vdusek vdusek commented Mar 27, 2026

Summary

  • Add Docusaurus versioning support with version dropdown in the navbar.
  • Add manual doc snapshots for versions 1.6 and 0.6 (with API reference).
  • Automate doc version creation on stable releases in the release workflow (minor/major create new versions, patches override the latest).

Mirrors the approach from apify-client-python PRs apify/apify-client-python#674 and apify/apify-client-python#676 and SDK apify/apify-sdk-python#834.

Issue

Test plan

  • Executed locally and checked manually
  • CI passes

🤖 Generated with 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 Mar 27, 2026
@vdusek vdusek self-assigned this Mar 27, 2026
@github-actions github-actions bot added this to the 137th sprint - Tooling team milestone Mar 27, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 27, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.24%. Comparing base (02a18ea) to head (dcd044e).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1815   +/-   ##
=======================================
  Coverage   92.23%   92.24%           
=======================================
  Files         157      157           
  Lines       10863    10882   +19     
=======================================
+ Hits        10020    10038   +18     
- Misses        843      844    +1     
Flag Coverage Δ
unit 92.24% <ø> (+<0.01%) ⬆️

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

☔ View full report in Codecov by Sentry.
📢 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 requested a review from Pijukatel March 27, 2026 14:51
@vdusek vdusek changed the title fix(website): remove stale JS SDK version links from navbar docs: add documentation versioning support Mar 27, 2026
Set up Docusaurus doc versioning with three versions:
- next (unreleased, from /docs directory)
- 1.6 (current release)
- 0.6 (last version of previous major)

Includes version dropdown in navbar, versioned API reference,
and automated version snapshotting in the release workflow.

Remove hardcoded version links (1.3, 2.2) pointing to sdk.apify.com
and the duplicate version dropdown logic, keeping only the one from
docusaurus.config.js.
@vdusek vdusek force-pushed the docs/remove-stale-js-sdk-version-links branch from d791f6b to 9d8ad94 Compare March 28, 2026 08:03
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.

Add docs versioning to Python projects

2 participants