Skip to content

fix(links): add specific anchors to all internal and icp-cli doc links#195

Merged
marc0olo merged 3 commits intomainfrom
infra/fix-anchor-links
May 5, 2026
Merged

fix(links): add specific anchors to all internal and icp-cli doc links#195
marc0olo merged 3 commits intomainfrom
infra/fix-anchor-links

Conversation

@marc0olo
Copy link
Copy Markdown
Member

@marc0olo marc0olo commented May 5, 2026

Summary

Comprehensive anchor link audit across all 159 docs pages. Fixes broken anchors from issue #191, upgrades generic CLI doc links to versioned paths with per-command anchors, and adds missing section anchors throughout.

Broken anchors fixed (issue #191):

  • ic-interface-spec/canister-interface.md: #ic-vetkd_encrypted_key (method renamed) → ./management-canister.md#ic-vetkd_derive_key
  • ic-interface-spec/management-canister.md: 3× #ic_upload_canister_snapshot_metadata (_ typo) → #ic-upload_canister_snapshot_metadata
  • guides/digital-assets/chain-key-tokens.mdx: #canister-ids (section doesn't exist) → ../../references/chain-key-canister-ids.md
  • guides/authentication/verifiable-credentials.md: #requesting-a-credential#implementing-a-relying-party
  • references/candid-spec.md: 4 stale portal anchors → #the-did-file and #safe-interface-upgrades
  • references/glossary.md: all same-page anchors verified correct; references/cycles-costs.md was linking to glossary.md without #xdr — fixed
  • getting-started/project-structure.mdx: 2 links to non-existent binding-generation.mdcandid.md#binding-generation

CLI doc links (cli.internetcomputer.org):

  • All bare root links upgraded to versioned paths (/0.2/)
  • Generic page links replaced with specific paths: reference/configuration, guides/creating-recipes, guides/canister-snapshots, guides/managing-environments, guides/containerized-networks, guides/installation
  • Command-specific links now include per-command anchors: #icp-canister-logs, #icp-canister-settings-update, #icp-cycles
  • Verified all paths against .sources/icp-cli/docs/

Missing section anchors added (~35 links across 15 files):
Security guides, backend guides, canister management, concepts — links that pointed to page tops now point to the specific section.

CLAUDE.md rules added:
Two new bullets in the "Never" section requiring specific anchors on both internal links and cli.internetcomputer.org links, with instructions on how to verify using .sources/icp-cli/docs/.

Sync recommendation

hand-written — no upstream source changes, pure link quality fixes.

- Fixes 2 broken file links (binding-generation.md → candid.md#binding-generation)
- Fixes 5 wrong anchors (candid-spec.md stale portal anchors, digital-asset-standards.md)
- Adds section anchors to ~35 links that pointed to page tops (cycles-costs.md,
  inter-canister-calls.mdx, management-canister.md, lifecycle guides, etc.)
- Upgrades all cli.internetcomputer.org links from bare root to versioned paths
  (/0.2/) with specific page paths and per-command anchors where applicable
- Fixes issue #191: vetkd_encrypted_key → vetkd_derive_key, ic_ → ic- prefix
  typos in management-canister.md, #canister-ids → chain-key-canister-ids.md,
  #requesting-a-credential → #implementing-a-relying-party, XDR → glossary.md#xdr
- Adds CLAUDE.md rules requiring specific anchors and versioned CLI doc paths
  so future agents don't reintroduce generic root links
Copy link
Copy Markdown

@ggreif ggreif left a comment

Choose a reason for hiding this comment

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

The link/anchor fixes look reasonable. I didn't thoroughly analyse the skill changes. Potential bugs therein should become next generation time (and be nailed down in short order).

@marc0olo marc0olo merged commit 7a8167e into main May 5, 2026
7 checks passed
@marc0olo marc0olo deleted the infra/fix-anchor-links branch May 5, 2026 09:07
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.

2 participants