Skip to content

docs: fix broken links in client docs#854

Merged
barjin merged 12 commits intomasterfrom
docs/check-links
Mar 5, 2026
Merged

docs: fix broken links in client docs#854
barjin merged 12 commits intomasterfrom
docs/check-links

Conversation

@barjin
Copy link
Member

@barjin barjin commented Feb 25, 2026

@barjin barjin self-assigned this Feb 25, 2026
@barjin barjin added the adhoc Ad-hoc unplanned task added during the sprint. label Feb 25, 2026
@github-actions github-actions bot added this to the 135th sprint - Tooling team milestone Feb 25, 2026
@github-actions github-actions bot added the t-tooling Issues with this label are in the ownership of the tooling team. label Feb 25, 2026
@barjin barjin changed the title docs: check for broken links with Lychee on new PRs docs: check for broken links on new PRs with Lychee Feb 25, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Feb 25, 2026

✅ The link checker did not find any broken links.

See more at https://github.com/apify/apify-client-js/actions/runs/22486423697#summary-65137089864

@apify apify deleted a comment from github-actions bot Feb 25, 2026
@apify apify deleted a comment from github-actions bot Feb 25, 2026
@barjin barjin requested a review from janbuchar February 27, 2026 12:37
@barjin barjin marked this pull request as ready for review February 27, 2026 12:37
@barjin barjin requested a review from l2ysho February 27, 2026 12:38
@barjin
Copy link
Member Author

barjin commented Feb 27, 2026

edit: the GH action has been moved to a separate PR

cc: reviewers, we might want to port this (the gh action) to the other documented projects as well. wdyt?

The link checking step will always pass, even with 404s. The only change is this comment - see its edit history for more context. If there are no broken links to begin with, this comment won't be generated to keep the spam levels low.

@barjin
Copy link
Member Author

barjin commented Mar 2, 2026

This has been discussed w/ @TC-MO today, as the Docs team wants to unify the docs checks in apify-docs and the subprojects. Some sort of reusable workflow used from all the repos is likely the way.

This comment was marked as resolved.

@barjin barjin changed the title docs: check for broken links on new PRs with Lychee docs: fix broken links in client docs Mar 2, 2026
@B4nan
Copy link
Member

B4nan commented Mar 3, 2026

Shouldn't we also add redirects for this?

@barjin
Copy link
Member Author

barjin commented Mar 3, 2026

fwd @TC-MO do you recall moving any of these links recently?

I wouldn't bother w/ the API docs links (it's just two endpoints, likely broken by the switch to a different API docs rendering plugin), but the Academy pages might have been linked from other places too

@TC-MO
Copy link
Contributor

TC-MO commented Mar 3, 2026

IIRC last time we touched any API reference links was during the reorganization ~last year

PR for reference : click

@barjin
Copy link
Member Author

barjin commented Mar 5, 2026

To answer @B4nan 's question, I couldn't find the old links in any of our other docs, nor in The Wayback Machine (the correct / new URL for the Academy page dates back to 2023).

This leads me to the conclusion that these were some one-off mistakes, and we probably don't have to bother with redirects here.

@barjin barjin merged commit a96ea43 into master Mar 5, 2026
8 checks passed
@barjin barjin deleted the docs/check-links branch March 5, 2026 16:41
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.

5 participants