Skip to content

docs: add docs link checker to PRs, fix broken links#638

Merged
barjin merged 8 commits into
masterfrom
chore/ci-link-checker
Jun 18, 2026
Merged

docs: add docs link checker to PRs, fix broken links#638
barjin merged 8 commits into
masterfrom
chore/ci-link-checker

Conversation

@barjin

@barjin barjin commented Jun 9, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Follow-up after apify/apify-client-js#858

@github-actions github-actions Bot added this to the 142nd sprint - Tooling team milestone Jun 9, 2026
@github-actions github-actions Bot added the t-tooling Issues with this label are in the ownership of the tooling team. label Jun 9, 2026
@barjin barjin added the adhoc Ad-hoc unplanned task added during the sprint. label Jun 9, 2026
@github-actions

github-actions Bot commented Jun 9, 2026 •
edited
Loading

Copy link
Copy Markdown

⚠️ There are broken links in the documentation.

See more at https://github.com/apify/apify-sdk-js/actions/runs/27338599900#summary-80769220789

@barjin barjin requested a review from szaganek as a code owner June 9, 2026 15:10
@barjin barjin removed the request for review from szaganek June 9, 2026 15:12
@barjin barjin marked this pull request as draft June 9, 2026 15:12
barjin and others added 5 commits June 10, 2026 11:47
@barjin @claude
fix: resolve crawlee EventManager apilink to class instead of 404 int…
5661aa8 
…erface

EventManager was declared twice in the @crawlee/core externalSymbolLinkMappings; the
second (interface) entry won and produced a 404. Drop the duplicate so it resolves to
the existing class page.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@barjin @claude
docs: fix rotted links across versioned docs and reference
e4c58d0 
Repair broken links surfaced by the lychee checker in the frozen versioned docs and
their committed typedoc snapshots:

- playwright env-vars page -> library#browser-downloads
- hub.docker.com org page (302) -> /u/apify
- crawlee CheerioRequestHandlerInputs -> CheerioCrawlingContext
- apify-client-js/latest anchors -> apify-client JS DatasetClient/RequestQueueClient
- MetaOrigin python enum -> platform runs-and-builds guide
- crawlee EventManager interface -> class
- apify store endpoint store-actors-get -> store-get

Also align the TypeScript guide slug with its filename and the production redirect
target by renaming the doc id to typescript-setup for the latest and next versions.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@barjin
docs: drop /blog from the docusaurus instance
fbea18a
@barjin
docs: improve run origin link
fe574d7
@barjin
chore: revert changes
9cda450
@barjin barjin mentioned this pull request Jun 10, 2026
Merged
@barjin

barjin commented Jun 10, 2026

Copy link
Copy Markdown
Member Author
Screenshot from 2026-06-10 13-50-44

@patrikbraborec It seems the type-script-actor => typescript-setup swap from #542 is unfinished. The document's frontmatter still contains id: type-script-actor, which emits the type-script-actor.html file in the build (see docs on ids and slugs).

At the same time, the nginx setup redirects ...../type-script-actor to ...../typescript-setup, which results in 404. You can check this by clicking through the links in the SDK docs to the Typescript actor page (will work), then reloading the page with Ctrl+R, which will show 404.

What is the intended behaviour? ..../typescript-setup being the only valid path? If so, can we update the id in this PR?

barjin added a commit to apify/crawlee that referenced this pull request Jun 11, 2026
@barjin
docs: fix broken links in the API reference (#3730)
1b06857 
Found through reexports at apify/apify-sdk-js#638
@barjin

barjin commented Jun 11, 2026

Copy link
Copy Markdown
Member Author

The last commits implement the fix from #638 (comment)

The broken links to the Client docs come from the re-exported Crawlee symbols. This has been fixed here (will come into force on the next stable Crawlee release).

@barjin barjin marked this pull request as ready for review June 11, 2026 10:03
@barjin barjin requested review from janbuchar and szaganek June 11, 2026 10:03
@barjin barjin changed the title chore: add docs link checker to PRs docs: add docs link checker to PRs, fix broken links Jun 15, 2026
@barjin barjin merged commit 28f16cf into master Jun 18, 2026
9 checks passed
@barjin barjin deleted the chore/ci-link-checker branch June 18, 2026 15:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@janbuchar janbuchar janbuchar approved these changes

@patrikbraborec patrikbraborec patrikbraborec approved these changes

@szaganek szaganek Awaiting requested review from szaganek szaganek is a code owner

Assignees

@barjin barjin

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

Milestone

142nd sprint - Tooling team

Development

Successfully merging this pull request may close these issues.

4 participants

@barjin @janbuchar @patrikbraborec @apify-service-account