docs: refresh stale README links after the docs migration - #4299
Open
marc0olo wants to merge 5 commits into
Open
docs: refresh stale README links after the docs migration#4299marc0olo wants to merge 5 commits into
marc0olo wants to merge 5 commits into
Conversation
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>
|
✅ No security or compliance issues detected. Reviewed everything up to d9dfc62. Security Overview
Detected Code Changes
|
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>
Contributor
There was a problem hiding this comment.
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 correspondingdocs.internetcomputer.org/*pages (including the spec anchor link). - Updated the “Flexible” SDK reference from the old
agent-jsrepo 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.
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>
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>
aterga
approved these changes
Aug 26, 2026
marc0olo
enabled auto-merge (squash)
August 26, 2026 16:52
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
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 developer docs moved to
docs.internetcomputer.org. The oldinternetcomputer.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
.../docs/current/references/ii-specdocs.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-protocolanchor 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 todfinity/icp-js-core. It links the published packages instead —@icp-sdk/authand@icp-sdk/core, the former declaring the latter as a peer dependency — matching the@icp-sdk/authreference 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.mdxstill containsdocs/current/*links, and that is correct. It is the upstream source for the published spec page:developer-docsconsumes it as a submodule and rewrites the links through thePATH_MAPinscripts/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 singleic-interface-specpage is split across several files on the new site, so the correct new URLs would no longer match theirPATH_MAPkeys and the script exits non-zero on unhandled links. Any change there has to land alongside aPATH_MAPupdate.src/frontend/src/lib/config.tsdefinesII_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.ic-interface-speclinks insrc/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