docs: catch up documentation with changes since v0.1#398
Merged
Conversation
- Use --detached for canister migration instead of dummy icp.yaml entries - Document --format flag on identity account-id - Document --encrypt and --encryption-password-file on identity export - Document minimum 8-character password requirement - Add legacy PEM compatibility note to dfx migration guide - Add gateway.domains to configuration reference - Use human-readable suffix notation in all config examples (4gib, 1t, 512mib instead of raw byte/cycle counts) - Add comments to all freezing_threshold examples (e.g. # 30 days) - Move telemetry implementation details to .claude/architecture.md - Add telemetry page to docs site navigation and index - Fix dead telemetry URL in first-run CLI notice to use versioned GitHub blob URL
adamspofford-dfinity
approved these changes
Mar 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Audited all 23 commits between
4dbc8d2andv0.2.0-beta.0and updated hand-written docs to match. The auto-generated CLI reference was already up to date.Changes
icp.yamlwithicp canister create --detached; removed obsolete cleanup steps--format ledger|icrc1onaccount-id,--encrypt/--encryption-password-fileonexport, minimum 8-character password requirementaccount-idcommand mapping with--formatnote; added legacy PEM compatibility calloutgateway.domainsto managed network properties table4gib,1t,512mib); documented memory and cycles suffixes; added# 30 days/# 90 dayscomments to allfreezing_thresholdexamples.claude/architecture.md; added telemetry to docs site sidebar (under "Other" group with dfx migration) and docs indexdocs.icp-cli.devURL in first-run CLI notice to use versioned GitHub blob URL (v{CARGO_PKG_VERSION})Files changed (14)
docs/guides/canister-migration.md--detachedworkflow, removed dummy icp.yaml patterndocs/guides/managing-identities.md--format, encrypted export, password minimumdocs/migration/from-dfx.md--formatnote, legacy PEM calloutdocs/reference/configuration.mdgateway.domains, suffix notation, commentsdocs/reference/canister-settings.mddocs/concepts/environments.mdfreezing_thresholdcommentdocs/guides/managing-environments.mddocs/telemetry.mddocs/index.mddocs-site/astro.config.mjs.claude/architecture.mdcrates/icp-cli/src/telemetry.rsexamples/icp-canister-settings/icp.yamldocs-site/package-lock.json