-
Notifications
You must be signed in to change notification settings - Fork 3
docs: update end user documentation #271
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
marc0olo
wants to merge
18
commits into
main
Choose a base branch
from
docs-structure-and-content
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Conversation
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
Incorporates design changes from main and updates documentation accordingly. Breaking Changes from main: - Removed --ic and --mainnet CLI flags (use --environment ic / -e ic) - Renamed implicit "mainnet" network to "ic" - Added implicit "ic" environment Documentation Updates: - Updated all CLI examples to use -e ic instead of --ic - Replaced "mainnet" terminology with "IC mainnet" - Documented both implicit environments (local and ic) - Updated network references from "mainnet" to "ic" Resolved Conflicts: - Removed docs/getting-started.md (replaced by new structure) - Removed docs/project-configuration.md (replaced by reference/configuration.md)
Incorporates design changes from main and updates documentation accordingly. Breaking Changes from main: - Removed --ic and --mainnet CLI flags (use --environment ic / -e ic) - Renamed implicit "mainnet" network to "ic" - Added implicit "ic" environment Documentation Updates: - Updated all CLI examples to use -e ic instead of --ic - Replaced "mainnet" terminology with "IC mainnet" - Documented both implicit environments (local and ic) - Updated network references from "mainnet" to "ic" Conflicts Resolved: - docs/guides/managing-environments.md: Merged description of ic environment and added missing deploy example
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 represents a complete overhaul of the icp-cli documentation, transforming it into a professional, framework-driven system that serves users at every stage of their journey.
Note:
What Changed
Implemented Diátaxis Documentation Framework
Reorganized documentation into four distinct categories following industry best practices:
New Content Added (~3,000 lines)
Improved Navigation
docs/index.mdREADME.mdwith clear documentation linksCONTRIBUTING.mdto project rootContent Cleanup