Conversation
raymondk
reviewed
Jan 20, 2026
Comment on lines
-120
to
-127
| **canister.yaml:** | ||
| **icp.yaml:** | ||
| ```yaml | ||
| name: backend | ||
| recipe: | ||
| type: "@dfinity/rust" | ||
| configuration: | ||
| package: backend | ||
| candid: "src/backend/backend.did" |
Contributor
There was a problem hiding this comment.
This stuff is actually correct.
You can specify a canister.yaml configuration and point to it from your icp.yaml
Member
Author
There was a problem hiding this comment.
yes, I know. but I explicitly asked to provide the example for icp.yaml to avoid confusion here 🤔
raymondk
approved these changes
Jan 20, 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
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.
This PR fixes critical documentation errors discovered through comprehensive verification against the source code. All examples and configuration references now accurately reflect the actual implementation.
Critical Fixes
Recipe Parameter Corrections
Fixed incorrect parameter names across multiple documentation files to match official recipe implementations:
Motoko recipe: Changed
entry:→main:docs/guides/using-recipes.mddocs/guides/creating-templates.md(3 occurrences)Asset canister recipe: Changed
source:→dir:and standardized recipe type to@dfinity/asset-canisterdocs/guides/using-recipes.mddocs/guides/creating-templates.mdVerification: Confirmed against official recipe templates
Sync Step Configuration Fixes
Corrected assets sync step field names to match the actual adapter implementation:
source: distandtarget: /dir: distFiles updated:
docs/reference/configuration.md(inline example)docs/concepts/build-deploy-sync.mddocs/guides/managing-environments.mdVerification: Source code at
crates/icp/src/manifest/adapter/assets.rsconfirms the adapter only supportsdirordirsfields.Removed Non-Existent Build Adapter Documentation
Removed entire "Assets Step" section from Build Steps in
docs/reference/configuration.md.Reason: The assets adapter only exists for sync steps, not build steps. The
BuildStepenum only supportsScriptandPrebuiltvariants. The documented fields (source,target,include_patterns,exclude_patterns) do not exist in the codebase.Script Name Corrections
Fixed references to schema generation script:
./scripts/config-schemas.sh(README) and./scripts/generate-config-schema.sh(CLAUDE.md - singular)./scripts/generate-config-schemas.sh(correct plural form)Files:
README.md,.claude/CLAUDE.mdEnhanced Migration Guide (
docs/migration/from-dfx.md)Major improvements with +128 net lines:
Corrected identity storage paths with OS-specific locations:
~/Library/Application Support/org.dfinity.icp-cli/identity/~/.local/share/icp-cli/identity/%APPDATA%\icp-cli\data\identity\Comprehensive identity migration instructions covering all three storage modes:
Asset canister build commands explaining dfx auto-builds vs icp-cli explicit configuration
Side-by-side tool usage with port conflict warning and solutions
Canister ID storage paths clarification for connected vs managed networks
Impact
Users will no longer encounter errors from following documentation examples. All YAML configuration examples now match:
examples/directorydocs/schemas/