docs: fix broken relative links on the SDK overview page#994
Merged
Conversation
vdusek
added
adhoc
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #994 +/- ##
=======================================
Coverage 90.54% 90.54%
=======================================
Files 49 49
Lines 3132 3132
=======================================
Hits 2836 2836
Misses 296 296
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
szaganek
approved these changes
Jun 17, 2026
vdusek
added a commit
that referenced
this pull request
Jun 17, 2026
…-start (#997) Follow-up to #994, fixing the broken relative links it didn't cover. Verified with a full `onBrokenLinks: 'throw'` docs build (0 broken links). - **Versioned reference links (1.7, 2.7):** `../../reference/...` over-traversed because these versions are served under a `/docs/<version>/` URL prefix. Corrected to `../../../reference/...`. - **Quick-start outbound links (all versions):** #994's new `slug: /quick-start` flattened these pages one level up, so their own `../concepts/...` and `../guides/...` links over-traversed. Corrected to `./concepts/...` / `./guides/...` (the same fix #994 applied to the overview page). - **Quick-start platform links (current + 3.4):** bare `/platform/...` resolved to a non-existent path under the `/sdk/python` baseUrl. Changed to absolute `https://docs.apify.com/platform/...`.
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
3 participants
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.
The overview page links to other docs with relative paths like
../concepts/.... Because the page setsslug: /overview, its URL is flattened to/sdk/python/docs/overview, so each../over-traverses and drops the/docs/segment. The result is broken links such as/sdk/python/concepts/actor-lifecycleinstead of/sdk/python/docs/concepts/actor-lifecycle.This corrects the relative depth to match the flattened URL (
./concepts/...,./guides/...), keeping the path-based link style.It also gives the quick start page its own
slug: /quick-start, so it is served at/sdk/python/docs/quick-startinstead of/sdk/python/docs/introduction/quick-start. The overview link goes back to./quick-start, and the one cross-link from the v1.7 requests-and-httpx guide is updated to match.Applied to the current docs and to all versioned snapshots (3.4, 2.7, 1.7, 0.2). The live page is served from the latest release (3.4), so it is fixed too.