Skip to content

docs: replace legacy sdk.apify.com links with docs.apify.com/sdk/js#613

Merged
B4nan merged 2 commits into
masterfrom
claude/nice-black-e7eeda
May 20, 2026
Merged

docs: replace legacy sdk.apify.com links with docs.apify.com/sdk/js#613
B4nan merged 2 commits into
masterfrom
claude/nice-black-e7eeda

Conversation

@B4nan
Copy link
Copy Markdown
Member

@B4nan B4nan commented May 20, 2026

Summary

  • Replaces references to the legacy sdk.apify.com domain with the current docs.apify.com/sdk/js URLs.
  • Prefers the ApiLink component (introduced in docs: use the common ApiLink implementation #610) for API references in MDX docs so they stay tied to the current version.
  • Updates the externalLink rehype plugin's internal-host allowlist to docs.apify.com.

Touched files:

  • MIGRATIONS.md, docs/04_upgrading/upgrading_v1.md — Docker image guide link.
  • docs/02_concepts/01_actor_lifecycle.mdx — switched all sdk.apify.com/api/apify/... links to <ApiLink>.
  • docs/03_guides/cheerio_crawler.ts — updated stale comment URL (CheerioCrawler now lives in Crawlee).
  • src/proxy_configuration.ts — warning message URL.
  • website/tools/utils/externalLink.js — internal-host list now matches docs.apify.com.

Versioned docs under website/versioned_docs/ were intentionally left untouched (they are frozen snapshots of past releases).

Closes #612

Test plan

  • npm run build (website) renders without broken-link errors
  • Spot-check that <ApiLink> references in docs/02_concepts/01_actor_lifecycle.mdx resolve to the correct API pages
  • Confirm the proxy warning message renders cleanly when triggered

🤖 Generated with Claude Code

The old `sdk.apify.com` domain is legacy. Replace references with the
current `docs.apify.com/sdk/js` URLs and prefer the `ApiLink` component
in MDX docs.

Closes #612

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions github-actions Bot added this to the 141st sprint - Tooling team milestone May 20, 2026
@github-actions github-actions Bot added the t-tooling Issues with this label are in the ownership of the tooling team. label May 20, 2026
@B4nan B4nan requested a review from barjin May 20, 2026 13:34
@B4nan B4nan added the adhoc Ad-hoc unplanned task added during the sprint. label May 20, 2026
Copy link
Copy Markdown
Member

@barjin barjin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, just one small nit. Cheers!

Comment thread docs/02_concepts/01_actor_lifecycle.mdx Outdated
The custom `ApiLink` wrapper strips the `apify/` prefix already, so the
shorter form (e.g. `class/Configuration`) works the same and matches
the convention used by the common `ApiLink` component.

Addresses review feedback on #613.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@B4nan B4nan merged commit 3829bbf into master May 20, 2026
7 checks passed
@B4nan B4nan deleted the claude/nice-black-e7eeda branch May 20, 2026 14:15
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.

The documentation is referring to sdk.apify.com

3 participants