fix: update execution error doc links to new docs URL#10268
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the base URL used by doc_ref() so execution error messages produced by the replica point to the new Execution Errors documentation site.
Changes:
- Switched the Execution Errors documentation link base from
internetcomputer.org/docs/current/...todocs.internetcomputer.org/....
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
This pull request changes code owned by the Governance team. Therefore, make sure that
you have considered the following (for Governance-owned code):
-
Update
unreleased_changelog.md(if there are behavior changes, even if they are
non-breaking). -
Are there BREAKING changes?
-
Is a data migration needed?
-
Security review?
How to Satisfy This Automatic Review
-
Go to the bottom of the pull request page.
-
Look for where it says this bot is requesting changes.
-
Click the three dots to the right.
-
Select "Dismiss review".
-
In the text entry box, respond to each of the numbered items in the previous
section, declare one of the following:
-
Done.
-
$REASON_WHY_NO_NEED. E.g. for
unreleased_changelog.md, "No
canister behavior changes.", or for item 2, "Existing APIs
behave as before.".
Brief Guide to "Externally Visible" Changes
"Externally visible behavior change" is very often due to some NEW canister API.
Changes to EXISTING APIs are more likely to be "breaking".
If these changes are breaking, make sure that clients know how to migrate, how to
maintain their continuity of operations.
If your changes are behind a feature flag, then, do NOT add entrie(s) to
unreleased_changelog.md in this PR! But rather, add entrie(s) later, in the PR
that enables these changes in production.
Reference(s)
For a more comprehensive checklist, see here.
GOVERNANCE_CHECKLIST_REMINDER_DEDUP
All 54 documentation links embedded in execution error messages were pointing to `internetcomputer.org/docs/current/references/execution-errors` which is no longer valid. Updated to `docs.internetcomputer.org/references/execution-errors`. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
marc0olo
force-pushed
the
mwalz/fix-execution-error-doc-links
branch
from
6570934 to
d86d011
Compare
marc0olo
dismissed
github-actions[bot]’s stale review
No changelog update needed — this is purely a URL fix in a metric description string with no canister behavior change.
mraszyk
left a comment
mraszyk
left a comment
There was a problem hiding this comment.
The link in "For the full specification of these constraints, see WebAssembly module requirements." is broken
|
@mraszyk is this another link that needs to be updated and should be covered in this PR? the new location is https://docs.internetcomputer.org/references/ic-interface-spec/canister-interface/#system-api-module |
Ideally yes, please |
Summary
All execution error messages printed by the ICP protocol include documentation links generated by the
doc_ref()function inrs/types/wasm_types/src/errors.rs. These links were pointing to old URLs that are no longer valid.Changes:
rs/types/wasm_types/src/errors.rs: updates the base URL indoc_ref(), fixing all 54 documentation links embedded in execution error messages across hypervisor/execution errors, Wasm validation errors, canister manager errors, and system API errorsrs/nervous_system/instruction_stats/src/lib.rs: updates the resource-limits link in thecandid_call_instructionsmetric descriptionNote: Until this change is deployed to mainnet, the old URLs should remain reachable (e.g. via redirects) so that users on older replica versions still get valid links.