Skip to content

docs: add cross-references to IC Dashboard APIs in relevant sections #222

Description

@marc0olo

Context

PR #209 adds docs/references/ic-dashboard-api.md covering all five public ICP Dashboard REST APIs:

  • IC API (ic-api.internetcomputer.org/api/v3/) — metrics, nodes, subnets, governance, canisters
  • Metrics API (metrics-api.internetcomputer.org/api/v1/) — time-series metrics
  • ICRC API (icrc-api.internetcomputer.org/api/v1/) — ICRC token data
  • Ledger API (ledger-api.internetcomputer.org/api/v1/) — ICP ledger data
  • SNS API (sns-api.internetcomputer.org/api/v1/) — SNS/governance data

Task

Add contextual cross-references from the relevant doc sections to the APIs they'd use most:

  • Tokens / ledger pages (PR docs: Batch 8 — tokens, ledgers, and cycles concepts #215docs/concepts/tokens-ledgers): link to ICRC API and Ledger API from ledgers.md or a dedicated digital assets guide
  • Governance pages (PR docs: Batch 7 — governance deep dives #216docs/concepts/governance-deep-dives): link to SNS API from governance or SNS concept pages
  • Protocol canisters reference (docs/references/protocol-canisters.md): link to IC API and Metrics API from the relevant sections (Bitcoin metrics, network metrics)
  • Chain-key tokens / digital assets guides: link to ICRC API for token balance and transaction queries

The reference page is at docs/references/ic-dashboard-api.md and is already linked from the references index and the performance concept page.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions