Skip to content

docs: add resource-limits page, rename cycles-costs to cycle-costs#267

Merged
marc0olo merged 2 commits into
mainfrom
docs/resource-limits
May 20, 2026
Merged

docs: add resource-limits page, rename cycles-costs to cycle-costs#267
marc0olo merged 2 commits into
mainfrom
docs/resource-limits

Conversation

@marc0olo
Copy link
Copy Markdown
Member

Summary

  • Adds docs/references/resource-limits.md as a dedicated reference page, separated from cycle costs (different reader intent: execution constraints vs. billing)
  • Renames references/cycles-costs.mdreferences/cycle-costs.md and fixes the title to "Cycle costs" (natural English compound noun, consistent with the page's own description)
  • Removes the condensed resource limits table from cycle-costs.md; replaces it with a cross-reference to the new page
  • Updates all 16 inbound links across 19 files; links in execution-errors.md and ic-interface-spec/canister-interface.md that were pointing to limit-related content now point to resource-limits.md with proper section anchors (#message-limits, #memory-limits)
  • Adds resource-limits sidebar entry between cycle-costs and subnet-types

Resource limits page coverage (ported from dfinity/portal docs/building-apps/canister-management/resource-limits.mdx, which the portal placed as a standalone page under canister-management):

  • Message limits
  • Instruction limits
  • Memory limits (including stable memory per-message access limits)
  • Wasm module limits
  • Subnet limits
  • Execution thread limits
  • Canister environment variables
  • Performance characteristics (prose)
  • Additional notes: ingress expiration, Wasm validation rules

Sync recommendation

informed by dfinity/portal docs/building-apps/canister-management/resource-limits.mdx — hand-maintained going forward; upstream tables should be cross-checked against the IC interface spec on spec version bumps.

…e-costs

- Add docs/references/resource-limits.md with full table coverage (message
  limits, instruction limits, memory, Wasm module, subnet, execution threads,
  environment variables) plus Performance characteristics and Additional notes
  prose sections ported from dfinity/portal
- Rename references/cycles-costs.md → references/cycle-costs.md; fix title
  from "Cycles costs" to "Cycle costs" (sentence-case, natural compound noun)
- Remove the condensed Resource limits table from cycle-costs.md; replace with
  a cross-reference to the new dedicated page
- Add resource-limits sidebar entry after cycle-costs, before subnet-types
- Update all 16 inbound links across concepts/, guides/, and references/;
  links in execution-errors.md and ic-interface-spec/canister-interface.md
  that pointed to resource-limit context now point to resource-limits.md
  (with #message-limits and #memory-limits anchors where appropriate)
@marc0olo marc0olo requested review from a team as code owners May 20, 2026 14:15
@github-actions github-actions Bot added the interface-spec Changes to the IC interface specification label May 20, 2026
@marc0olo marc0olo merged commit 52f0c21 into main May 20, 2026
11 checks passed
@marc0olo marc0olo deleted the docs/resource-limits branch May 20, 2026 15:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

interface-spec Changes to the IC interface specification

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants