Skip to content

docs: network overview concept page#3

Merged
marc0olo merged 3 commits into
mainfrom
docs/concepts-network-overview
Mar 13, 2026
Merged

docs: network overview concept page#3
marc0olo merged 3 commits into
mainfrom
docs/concepts-network-overview

Conversation

@marc0olo
Copy link
Copy Markdown
Member

@marc0olo marc0olo commented Mar 13, 2026

Summary

  • Foundational concepts/network-overview.md page explaining ICP's network architecture
  • Covers subnets, nodes, consensus protocol (4-phase), boundary nodes, chain-key cryptography, and governance
  • Uses @icp-sdk/core/agent (replacing superseded @dfinity/agent)
  • Clarifies query call authenticity in request flow: responses are not threshold-signed
  • Uses "icp-cli" naming convention in prose

Sync recommendation

informed by dfinity/portal — network-overview.mdx

@marc0olo
Copy link
Copy Markdown
Member Author

Review: concepts/network-overview.md — Changes Requested

Cleanest of the four pages. Clear, developer-focused, well-scoped. One issue to fix:

1. Broken link: certified-variables.md

The link [certified variables](../reference/certified-variables.md) in the Boundary nodes section points to a file that doesn't exist. Same issue as PR #2.

Fix: Link to ../reference/ic-interface-spec.md with appropriate anchor text, or file a page proposal issue and link to the new stub.

2. Minor nit: hardcoded node counts

Subnets currently range from 13 to 40 nodes.

Accurate today but will date. Consider softening to "typically range from 13 to 40 nodes" or linking to the dashboard for current numbers.

✓ Verified

  • All other internal links point to existing stubs
  • No CLI commands to verify
  • Content is accurate and well-scoped

@marc0olo
Copy link
Copy Markdown
Member Author

Review: concepts/network-overview.md (round 2)

Must fix

  • Broken link: ../reference/certified-variables.md — This file does not exist. The correct path is ../guides/backends/certified-variables.md. (Flagged in round 1, still unfixed.)

Suggestions

  • Hardcoded subnet sizes — "Subnets currently range from 13 to 40 nodes" will date. Consider softening to "typically range from 13 to 40 nodes."
  • Repeated finality claim — "1–2 seconds" appears in three places (Subnets, Consensus, How it all fits together). Consider one authoritative statement + references to reduce maintenance burden.
  • Missing Learn Hub links — The stub's source material listed 5 Learn Hub articles. The page links to none. Consider adding at least one for readers who want protocol details (per linking rules: protocol internals → https://learn.internetcomputer.org).

Verified

  • 6 of 7 internal links resolve (only certified-variables.md is broken)
  • Four-phase consensus description is accurate
  • No CLI commands to verify (none present)
  • No dfx references, no .mdx/JSX
  • Frontmatter complete and self-consistent
  • Content brief fully covered (subnets, nodes, consensus, boundary nodes, latency, finality, replication)

…or developers

Covers subnets, nodes, consensus (4-phase protocol), boundary nodes,
chain-key cryptography, and governance. Focuses on what developers need
to know: latency, finality, replication, and how requests flow.

Source: portal essentials/network-overview.mdx
- Fix broken link: certified-variables now points to guides/backends/
- Change "currently" to "typically" for subnet node ranges
- Reduce repeated 1-2 second finality claims
- Add Learn Hub link for protocol details
@marc0olo marc0olo force-pushed the docs/concepts-network-overview branch from a73642e to 0fc29a1 Compare March 13, 2026 11:10
@marc0olo
Copy link
Copy Markdown
Member Author

Feedback addressed:

  • Fixed broken link ../reference/certified-variables.md../guides/backends/certified-variables.md
  • Softened hardcoded subnet sizes ("currently" → "typically")
  • Reduced repeated "1–2 seconds" finality claims (kept first, replaced duplicates with back-references)
  • Added Learn Hub link for protocol details

Comment thread docs/concepts/network-overview.md Outdated
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a foundational “Network Overview” concept page explaining ICP’s network architecture and how requests flow from clients to canisters, with emphasis on developer-relevant performance and replication properties.

Changes:

  • Replaces placeholder content with an end-to-end explanation of subnets, nodes, consensus, and boundary nodes.
  • Introduces sections on chain-key cryptography and governance, plus “what’s next” cross-links.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Comment thread docs/concepts/network-overview.md Outdated
Comment thread docs/concepts/network-overview.md Outdated
- Replace @dfinity/agent with @icp-sdk/core/agent
- Fix misleading query call signing wording
- Use icp-cli naming convention in prose
@marc0olo
Copy link
Copy Markdown
Member Author

Feedback addressed:

  • Replaced @dfinity/agent with @icp-sdk/core/agent (superseded)
  • Fixed query call wording in request flow: clarified responses are not threshold-signed, linked to certified variables
  • Changed "icp CLI" to "icp-cli" in prose per naming convention

@marc0olo marc0olo merged commit ec31bb8 into main Mar 13, 2026
@marc0olo marc0olo deleted the docs/concepts-network-overview branch March 13, 2026 17:47
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