Skip to content

docs: refresh stale README links after the docs migration - #4299

Open
marc0olo wants to merge 5 commits into
mainfrom
docs/fix-readme-docs-links
Open

docs: refresh stale README links after the docs migration#4299
marc0olo wants to merge 5 commits into
mainfrom
docs/fix-readme-docs-links

Conversation

@marc0olo

@marc0olo marc0olo commented Aug 26, 2026

Copy link
Copy Markdown
Member

The developer docs moved to docs.internetcomputer.org. The old internetcomputer.org/docs/current/* URLs in the README now 301 to the docs homepage, so they lose the target page entirely. This PR fixes those, plus two other stale links spotted along the way, and drops "smart contract" from the prose.

Documentation links

Old New
.../docs/current/references/ii-spec docs.internetcomputer.org/references/internet-identity-spec
.../docs/current/developer-docs/integrations/internet-identity/ docs.internetcomputer.org/guides/authentication/internet-identity
.../docs/current/developer-docs/build/languages/candid/candid-concepts/ docs.internetcomputer.org/guides/canister-calls/candid/

All new URLs return 200, and the #client-authentication-protocol anchor referenced from the "Integrating with Internet Identity" section still exists as a heading id on the new spec page.

Both "Internet Identity documentation" links were followed by "on internetcomputer.org", which named the wrong host once the docs moved. Rather than correct the host, the attribution is gone — repeating where a link points adds nothing.

SDK links

The Flexible bullet pointed at github.com/dfinity/agent-js, which now redirects to dfinity/icp-js-core. It links the published packages instead — @icp-sdk/auth and @icp-sdk/core, the former declaring the latter as a peer dependency — matching the @icp-sdk/auth reference further down in the README.

Terminology

Dropped the two uses of "smart contract". Both were glosses on "canister" rather than load-bearing terms — "the canister smart contract" in the Flexible bullet, and "canisters (canister smart contracts)" in the architecture overview — so removing them costs no meaning.

Deliberately not touched

  • docs/ii-spec.mdx still contains docs/current/* links, and that is correct. It is the upstream source for the published spec page: developer-docs consumes it as a submodule and rewrites the links through the PATH_MAP in scripts/sync-ii-spec.mjs, which canonicalizes both the legacy and current URL forms precisely because the two repos do not migrate in lockstep. The rendered page carries no stale links. Rewriting them here would in fact break that sync — upstream's single ic-interface-spec page is split across several files on the new site, so the correct new URLs would no longer match their PATH_MAP keys and the script exits non-zero on unhandled links. Any change there has to land alongside a PATH_MAP update.
  • src/frontend/src/lib/config.ts defines II_DEVELOPER_DOCS_URL, whose URL is likewise dead. It is exported but never imported anywhere in the repo — leftover from Landing Page #3341 — so nothing ships it to users. It wants deleting rather than updating; out of scope for a README PR.
  • Remaining ic-interface-spec links in src/try-ii/README.md, src/sig-verifier-js/README.md, and assorted Rust/Candid doc comments are genuinely stale but cosmetic. Happy to sweep them separately.

🤖 Generated with Claude Code

The developer docs moved to docs.internetcomputer.org. The old
internetcomputer.org/docs/current/* URLs now redirect to the docs
homepage, losing the target page.

- II specification -> references/internet-identity-spec (the
  #client-authentication-protocol anchor still exists there)
- II integration guide -> guides/authentication/internet-identity
- Candid concepts -> guides/canister-calls/candid

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@marc0olo
marc0olo requested a review from a team as a code owner August 26, 2026 16:34
Copilot AI lite review requested due to automatic review settings August 26, 2026 16:34
@zeropath-ai

zeropath-ai Bot commented Aug 26, 2026

Copy link
Copy Markdown

No security or compliance issues detected. Reviewed everything up to d9dfc62.

Security Overview
Detected Code Changes
Change Type Relevant files
Bug Fix ► README.md
    Update external links and references to newer documentation URLs

github.com/dfinity/agent-js now redirects to dfinity/icp-js-core, and
the library it referred to has been published as @icp-sdk/core with
@icp-sdk/auth on top of it (declared as a peer dependency). Point at
both packages instead, matching the @icp-sdk/auth reference further
down in the README.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@marc0olo marc0olo changed the title docs: point README links at docs.internetcomputer.org docs: refresh README documentation and SDK links Aug 26, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates the root README to reflect the migration of Internet Identity documentation/spec pages to docs.internetcomputer.org, and refreshes SDK references to avoid redirects and keep the README’s integration guidance current.

Changes:

  • Replaced legacy internetcomputer.org/docs/current/* links with the corresponding docs.internetcomputer.org/* pages (including the spec anchor link).
  • Updated the “Flexible” SDK reference from the old agent-js repo link to the published @icp-sdk/* packages.
  • Refreshed reference-style link targets ([spec], [candid]) to the new documentation host.
Suppressed comments (1)

README.md:141

  • This line says the documentation is “on internetcomputer.org”, but the actual URL is on docs.internetcomputer.org. Update the displayed domain/link to match the new docs host.
- [Internet Identity Documentation](https://docs.internetcomputer.org/guides/authentication/internet-identity) on [internetcomputer.org](https://internetcomputer.org)

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread README.md Outdated
Both "Internet Identity documentation" links now point at
docs.internetcomputer.org while the trailing attribution still read
"on internetcomputer.org", which is confusing now that the two are
different hosts.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@marc0olo marc0olo changed the title docs: refresh README documentation and SDK links docs: refresh stale README links after the docs migration Aug 26, 2026
marc0olo and others added 2 commits August 26, 2026 18:40
Both uses were glosses on "canister" rather than load-bearing terms,
so dropping them costs no meaning.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Naming the host after a link that already points there added nothing.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@marc0olo
marc0olo enabled auto-merge (squash) August 26, 2026 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants