Skip to content

docs: add evolution & scaling concept page (Batch 4)#212

Merged
marc0olo merged 5 commits into
infra/learn-hub-migration-prepfrom
docs/concepts-evolution-scaling
May 8, 2026
Merged

docs: add evolution & scaling concept page (Batch 4)#212
marc0olo merged 5 commits into
infra/learn-hub-migration-prepfrom
docs/concepts-evolution-scaling

Conversation

@marc0olo
Copy link
Copy Markdown
Member

@marc0olo marc0olo commented May 6, 2026

Summary

  • Creates docs/concepts/evolution-scaling.md covering four topics from the Learn Hub:
    • Fault tolerance: CUP mechanism, epoch checkpoints, node recovery steps, subnet recovery via NNS proposal, NNS canister failures (lifeline/root/governance upgrade hierarchy), and NNS subnet failures (manual node provider recovery)
    • Subnet creation: horizontal scaling via XNet messaging, 4-step subnet creation process (node onboarding, NNS proposal, community vote, subnet genesis)
    • Chain evolution: NNS-governed protocol upgrades, registry versioning, epoch-boundary coordination, CUP handoff to new replica version, upgrade governance
  • Adds 6 images from Learn Hub source articles: subnet diagram, NNS proposal flow, registry versioning, epoch boundary transition, CUP handoff, upgrade proposal
  • Adds concepts/evolution-scaling to the sidebar (explicit Concepts items array)
  • Updates docs/concepts/chain-key-cryptography.md: replaces Learn Hub chain-evolution link with internal path
  • Updates docs/references/glossary.md: replaces Learn Hub fault-tolerance link with internal path

Completeness audit (staff technical writer sign-off)

Source articles audited element-by-element via Zendesk API raw HTML:

  • Evolution & Scaling (34576974172692): overview article only — content absorbed into sections ✓
  • Fault Tolerance (34210647901460): all sections migrated including NNS canister/subnet failure sections and video links in Further reading ✓
  • Subnet Creation (34209955782420): all content migrated including 2 images ✓ (DFINITY etymology intro and vertical/horizontal scaling textbook intro appropriately omitted as non-technical)
  • Chain Evolution (34210120121748): all content migrated including 4 images and additional resources (blog post, whitepaper, videos) ✓ (historical Ethereum/Bitcoin upgrade context appropriately omitted)

Sync recommendation

hand-written

@marc0olo marc0olo requested a review from a team as a code owner May 6, 2026 15:01
@marc0olo
Copy link
Copy Markdown
Member Author

marc0olo commented May 6, 2026

Review notes

Two broken links need to be resolved before merge:

Broken links (blocking, dependency on #209): The "Further reading" section links to protocol/state-synchronization.md and protocol/index.md. Neither path exists on main until PR #209 merges. These will produce dead links or build failures.

Options:

No other issues: frontmatter complete, chain-key-cryptography.md and glossary.md cross-links correctly updated, <!-- Upstream: --> comment present, no banned patterns.

@marc0olo
Copy link
Copy Markdown
Member Author

marc0olo commented May 6, 2026

Two issues to fix in docs/concepts/evolution-scaling.md before merging:

1. Em-dashes in "Further reading" bullets (lines 74–76)

Em-dashes () are banned project-wide per AGENTS.md. All three bullets in the "Further reading" section use them. Replace each with : .

2. Broken links in "Further reading" (lines 74–75)

protocol/index.md and protocol/state-synchronization.md are referenced but don't exist yet — they land in PR #209. Options:

Either way, npm run build will fail with broken-link errors until #209 is in.

@marc0olo
Copy link
Copy Markdown
Member Author

marc0olo commented May 6, 2026

Feedback addressed:

@marc0olo marc0olo force-pushed the infra/learn-hub-migration-prep branch from dabad66 to d191270 Compare May 8, 2026 09:02
@marc0olo marc0olo force-pushed the docs/concepts-evolution-scaling branch from 1cdbdc4 to 5b4e9cc Compare May 8, 2026 09:18
marc0olo added 3 commits May 8, 2026 16:58
…reation, chain evolution)

Migrates 4 Learn Hub articles from the "Evolution & Scaling" section into a
single docs/concepts/evolution-scaling.md page covering fault tolerance and
node recovery, horizontal subnet scaling and XNet messaging, and governance-
driven protocol upgrades via epoch-boundary transitions.

Updates chain-key-cryptography.md: replaces Learn Hub chain-evolution link.
Updates glossary.md: replaces Learn Hub fault-tolerance link.
…d sidebar entry

- Add 6 images from Learn Hub source (subnet diagram, NNS proposal flow,
  registry versioning, epoch boundary transition, CUP handoff, upgrade proposal)
- Add NNS canister failures subsection (lifeline/root/governance upgrade hierarchy)
- Add NNS subnet failures subsection (manual node provider recovery)
- Expand NNS on first use: "Network Nervous System (NNS)"
- Add further reading links (blog post, whitepaper, 3 videos)
- Add concepts/evolution-scaling to sidebar
@marc0olo marc0olo force-pushed the docs/concepts-evolution-scaling branch from 5b4e9cc to 6124d13 Compare May 8, 2026 15:03
@marc0olo
Copy link
Copy Markdown
Member Author

marc0olo commented May 8, 2026

Feedback addressed:

  • Registry desired vs actual state: Added note after CUP handoff steps — "The registry records the desired configuration, not the current running version. A subnet may continue running an older version until the CUP handoff completes. Nodes determine the actual current version by querying peers for the highest valid CUP."
  • "Subnet blockchain" terminology: Removed from step 4 ("The nodes form the subnet and begin accepting messages") and from the image alt text on line 48
  • Summary block precision: Updated to "The first block of each epoch is a summary block containing the configuration for both the current epoch and the next one. Nodes therefore know the upcoming version from the start of the current epoch, not at the last moment."
  • 55-minute video: Intentionally omitted — a 55-minute video is impractical as a docs reference for this page. The 10-minute core protocol upgrades video covers the same material at an appropriate depth.
  • Post-merge link restoration: Tracked. State synchronization and protocol stack links to be restored once docs: add protocol stack concept pages (Batch 1) #209 is fully in the base branch.

@marc0olo marc0olo merged commit 6d46200 into infra/learn-hub-migration-prep May 8, 2026
3 checks passed
@marc0olo marc0olo deleted the docs/concepts-evolution-scaling branch May 8, 2026 16:12
marc0olo added a commit that referenced this pull request May 11, 2026
## Summary
- Creates `docs/concepts/evolution-scaling.md` covering four topics from
the Learn Hub:
- **Fault tolerance**: CUP mechanism, epoch checkpoints, node recovery
steps, subnet recovery via NNS proposal, NNS canister failures
(lifeline/root/governance upgrade hierarchy), and NNS subnet failures
(manual node provider recovery)
- **Subnet creation**: horizontal scaling via XNet messaging, 4-step
subnet creation process (node onboarding, NNS proposal, community vote,
subnet genesis)
- **Chain evolution**: NNS-governed protocol upgrades, registry
versioning, epoch-boundary coordination, CUP handoff to new replica
version, upgrade governance
- Adds 6 images from Learn Hub source articles: subnet diagram, NNS
proposal flow, registry versioning, epoch boundary transition, CUP
handoff, upgrade proposal
- Adds `concepts/evolution-scaling` to the sidebar (explicit Concepts
items array)
- Updates `docs/concepts/chain-key-cryptography.md`: replaces Learn Hub
chain-evolution link with internal path
- Updates `docs/references/glossary.md`: replaces Learn Hub
fault-tolerance link with internal path

## Completeness audit (staff technical writer sign-off)
Source articles audited element-by-element via Zendesk API raw HTML:
- **Evolution & Scaling** (34576974172692): overview article only —
content absorbed into sections ✓
- **Fault Tolerance** (34210647901460): all sections migrated including
NNS canister/subnet failure sections and video links in Further reading
✓
- **Subnet Creation** (34209955782420): all content migrated including 2
images ✓ (DFINITY etymology intro and vertical/horizontal scaling
textbook intro appropriately omitted as non-technical)
- **Chain Evolution** (34210120121748): all content migrated including 4
images and additional resources (blog post, whitepaper, videos) ✓
(historical Ethereum/Bitcoin upgrade context appropriately omitted)

## Sync recommendation
hand-written

<!-- Upstream: informed by Learn Hub articles "Evolution & Scaling"
(34576974172692), "Fault Tolerance" (34210647901460), "Subnet Creation"
(34209955782420), "Chain Evolution" (34210120121748) (migrated, source
retired) -->
raymondk pushed a commit that referenced this pull request May 11, 2026
…ocs (#208)

## Summary

Migrates all 57 developer-relevant articles from the Learn Hub \"How
does ICP work?\" section into the developer docs, replacing Learn Hub as
the canonical source for ICP protocol concepts before the site is
retired.

This was executed as 9 content batch PRs plus a post-migration review
pass, all merged into this staging branch before landing on `main`:

**Batch 1 — Protocol stack** (#209): Consensus, peer-to-peer, message
routing, execution layer, state synchronization, and performance concept
pages under `docs/concepts/protocol/`.

**Batch 2 — Node infrastructure** (#210):
`docs/concepts/node-infrastructure.md` — TEE (SEV-SNP) attestation,
IC-OS layer model (SetupOS / HostOS / GuestOS), TEE key derivation and
disk encryption.

**Batch 3 — Edge infrastructure** (#211):
`docs/concepts/edge-infrastructure.md` — boundary nodes, HTTP gateway,
edge caching.

**Batch 4 — Evolution and scaling** (#212):
`docs/concepts/evolution-scaling.md` — horizontal scaling via subnet
sharding, fault tolerance, governance-driven subnet creation, forkless
protocol upgrades.

**Chain fusion deep dives** (#213): Expanded
`docs/concepts/chain-fusion/` with dedicated pages for Bitcoin
integration, ckBTC mechanics, Ethereum integration, EVM RPC, Solana RPC,
Dogecoin integration, and Exchange Rate Canister. Architecture and flow
diagrams migrated to `public/concepts/chain-fusion/`.

**Cryptography deep dives** (#214): Expanded
`docs/concepts/chain-key-cryptography.md` and
`docs/concepts/certified-data.md` with subnet keys, threshold signing
internals, and certified communication theory.

**Tokens, ledgers, and cycles** (#215): Expanded
`docs/concepts/ledgers.md` and `docs/concepts/cycles.md` with ledger
architecture, accounts, sub-accounts, cycles ledger transfer semantics,
and NNS tokenomics.

**Governance deep dives** (#216): Expanded `docs/concepts/governance.md`
and added `docs/concepts/sns-framework.md` — NNS neuron attributes and
bonuses, voting rewards formula, Neurons Fund, proposal taxonomy, SNS
framework and architecture, DAO settings, launch flow, SNS neurons and
rewards, and SNS proposals.

**Principals and canister model** (#217): Expanded
`docs/concepts/principals.md` and `docs/concepts/canisters.md` —
principal model, canister control, Wasm execution model, and
`docs/concepts/app-architecture.md`.

**Post-migration holistic review** (#218, #226):
- Navigation restructured across all concepts, guides, and references —
sentence case applied throughout, section indices completed
- Cross-reference audit: all Learn Hub outbound links replaced with
internal doc links; first-use terms linked to their concept pages
- Glossary expanded with TEE, boundary node, and cycle-related entries
- System canisters content placement corrected
- Exchange Rate Canister restructured across concept, reference, and
guide pages (#XRC commits)

**Migration infrastructure** (initial prep commits):
- `.docs-plan/learn-hub-migration.md` — agent workflow and authoring
rules for 9-batch execution
- `.docs-plan/learn-hub-navigation.md` — per-article mapping (target
file, action type, cross-link table)
- `AGENTS.md / CLAUDE.md` — Learn Hub removed from external-docs list;
linking rule updated
- `sidebar.mjs` — all new concept pages registered

## Closes

- Closes #187 — Content gap analysis: Learn Hub vs developer docs
- Closes #190 — Gap analysis: articles on learn.internetcomptuter.org vs
developer-docs `reference` and `concepts`
- Closes #226 — Post-migration holistic review (content placement, nav
structure, glossary, first-use terms)

## Sync recommendation

hand-written (all pages authored from Learn Hub source articles via
Zendesk API; no upstream repo to sync from)

<!-- Upstream: source articles fetched from learn.internetcomputer.org
via Zendesk API (2026-05-06 through 2026-05-11) -->
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.

1 participant