Skip to content

docs: fix guides and references#283

Merged
raymondk merged 1 commit intomainfrom
marc0olo/docs-fixes
Jan 20, 2026
Merged

docs: fix guides and references#283
raymondk merged 1 commit intomainfrom
marc0olo/docs-fixes

Conversation

@marc0olo
Copy link
Copy Markdown
Member

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.md
    • docs/guides/creating-templates.md (3 occurrences)
  • Asset canister recipe: Changed source:dir: and standardized recipe type to @dfinity/asset-canister

    • docs/guides/using-recipes.md
    • docs/guides/creating-templates.md

Verification: Confirmed against official recipe templates

Sync Step Configuration Fixes

Corrected assets sync step field names to match the actual adapter implementation:

  • Before: source: dist and target: /
  • After: dir: dist

Files updated:

  • docs/reference/configuration.md (inline example)
  • docs/concepts/build-deploy-sync.md
  • docs/guides/managing-environments.md

Verification: Source code at crates/icp/src/manifest/adapter/assets.rs confirms the adapter only supports dir or dirs fields.

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 BuildStep enum only supports Script and Prebuilt variants. The documented fields (source, target, include_patterns, exclude_patterns) do not exist in the codebase.

Script Name Corrections

Fixed references to schema generation script:

  • Before: ./scripts/config-schemas.sh (README) and ./scripts/generate-config-schema.sh (CLAUDE.md - singular)
  • After: ./scripts/generate-config-schemas.sh (correct plural form)

Files: README.md, .claude/CLAUDE.md

Enhanced Migration Guide (docs/migration/from-dfx.md)

Major improvements with +128 net lines:

  1. Corrected identity storage paths with OS-specific locations:

    • macOS: ~/Library/Application Support/org.dfinity.icp-cli/identity/
    • Linux: ~/.local/share/icp-cli/identity/
    • Windows: %APPDATA%\icp-cli\data\identity\
  2. Comprehensive identity migration instructions covering all three storage modes:

    • Keyring (default)
    • Password-protected
    • Plaintext
  3. Asset canister build commands explaining dfx auto-builds vs icp-cli explicit configuration

  4. Side-by-side tool usage with port conflict warning and solutions

  5. 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:

  • Source code implementation
  • Official recipe templates
  • Working examples in examples/ directory
  • JSON schemas in docs/schemas/

@marc0olo marc0olo requested a review from a team as a code owner January 20, 2026 19:54
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"
Copy link
Copy Markdown
Contributor

@raymondk raymondk Jan 20, 2026

Choose a reason for hiding this comment

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

This stuff is actually correct.
You can specify a canister.yaml configuration and point to it from your icp.yaml

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

yes, I know. but I explicitly asked to provide the example for icp.yaml to avoid confusion here 🤔

@raymondk raymondk merged commit 1210ad9 into main Jan 20, 2026
48 checks passed
@raymondk raymondk deleted the marc0olo/docs-fixes branch January 20, 2026 20:29
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