docs: make icp CLI primary, add deprecation banners for dfx pages#6228
Closed
artkorotkikh-dfinity wants to merge 1 commit intomasterfrom
Closed
docs: make icp CLI primary, add deprecation banners for dfx pages#6228artkorotkikh-dfinity wants to merge 1 commit intomasterfrom
artkorotkikh-dfinity wants to merge 1 commit intomasterfrom
Conversation
- install.mdx: icp CLI is now the primary install path (npm install -g @icp-sdk/icp-cli); dfx moved to a clearly-labelled legacy section with a migration callout - dev-tools-overview.mdx: icp CLI section added first with recommended tag; dfx section demoted to legacy with caution admonition; CDK section description updated to remove dfx-specific wording - docusaurus.config.js: add cli.internetcomputer.org to the Resources nav dropdown so the icp CLI is discoverable from every page - src/theme/DocItem/Layout/index.js: inject deprecation banner on every /developer-tools/dfx/* page pointing to cli.internetcomputer.org and the migration guide Fixes: every new developer was being routed through the wrong CLI. This is the P0 docs fix identified in the ICP presence audit. Co-Authored-By: Paperclip <noreply@paperclip.ing>
Contributor
|
@artkorotkikh-dfinity I'm not sure if it's worth spending time on this We're working on - https://beta-docs.internetcomputer.org/ coming out of https://github.com/dfinity/developer-docs |
Contributor
Author
|
Makes sense @raymondk ! Marko reached out to me, and I gave the context that it was not fully intentional. Was experimenting with agents, and this one was a bit too proactive... Sorry for the noise and looking forward to the new portal! |
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.
Summary
This PR fixes the P0 docs issue identified in the ICP presence audit: every new developer landing on
docs.internetcomputer.orgwas being routed through the legacydfxCLI with no mention oficp.Changes
install.mdx—icpCLI is now the primary install path (npm install -g @icp-sdk/icp-cli);dfxmoved to a clearly-labelled## IC SDK (dfx) — legacysection with a caution admonition and link to the migration guidedev-tools-overview.mdx— addedicpCLI section first with "recommended" framing; demoteddfxsection to legacy with caution admonition linking tocli.internetcomputer.org/docs/migration; CDK section description de-coupled fromdfx-specific wordingdocusaurus.config.js— addedcli.internetcomputer.orgas the first item in the Resources nav dropdown so theicpCLI is discoverable from every docs pagesrc/theme/DocItem/Layout/index.js— new Docusaurus theme swizzle that injects a deprecation banner on every/developer-tools/dfx/*page: "dfxis the legacy CLI. New projects should use the icp CLI instead. View the dfx → icp migration guide →"What this fixes
dfx install/dfx --versionas primary, noicpmentionicpCLI primary at top;dfxdemoted to legacy sectiondfxdescribed as "the primary tool",icp-clinot listedicpCLI listed first as recommended;dfxas legacydfxcommand page: no deprecation noticedfx/*page: yellow banner → icp CLI + migration guidecli.internetcomputer.orgicp CLIlink addedNote on dfx command reference pages
The
dfxcommand reference pages (e.g.dfx deploy,dfx canister, etc.) live in thesubmodules/sdkgit submodule. The deprecation banner injected viaDocItem/Layoutcovers all of these pages without requiring changes to the submodule.Test plan
yarn buildpasses without errors/building-apps/getting-started/installshowsicpCLI section beforedfxsection/building-apps/developer-tools/dev-tools-overviewshowsicpCLI section first with recommended tag/building-apps/developer-tools/dfx/*page shows the yellow deprecation bannericp CLIlink tocli.internetcomputer.org🤖 Generated with Claude Code