-
Notifications
You must be signed in to change notification settings - Fork 7
feat(docs): Add comprehensive CLI documentation suite #301
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
Open
mtorres11
wants to merge
2
commits into
ion-fusion:main
Choose a base branch
from
mtorres11:mtorres11/cli-documentation-improvement
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.
Open
feat(docs): Add comprehensive CLI documentation suite #301
mtorres11
wants to merge
2
commits into
ion-fusion:main
from
mtorres11:mtorres11/cli-documentation-improvement
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
- Complete CLI reference with all commands, options, and examples - Quick start guide for immediate productivity - Troubleshooting guide for common issues - Enhanced tutorial with real-world workflows - Improved installation documentation - Updated navigation and cross-references Transforms fragmented CLI docs into complete, user-friendly documentation.
SharkBaitDLS
requested changes
Oct 3, 2025
- Change 'JSON-like data' to 'Ion data' for accuracy - Add link to Ion Fusion website (https://ion-fusion.dev/) - Replace community section with link to website community page - Update performance tips to focus on Fusion-specific optimizations - Add Corretto .deb distribution and MacPorts installation options - Fix missing links in build documentation - Remove accidentally committed gradle.properties and setup script - Update Amazon references to Ion-Fusion where appropriate Addresses feedback from PR ion-fusion#301
SharkBaitDLS
requested changes
Oct 3, 2025
rationull
reviewed
Oct 9, 2025
<!-- Copyright Ion Fusion contributors. All rights reserved. --> | ||
<!-- SPDX-License-Identifier: Apache-2.0 --> | ||
|
||
# Ion Fusion CLI Reference |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems like it'll end up hard to maintain. Do we have a path forward for auto-generating CLI docs like this from our CLI implementation, once we're moved to a new CLI framework?
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.
Transforms fragmented CLI docs into complete, user-friendly documentation.
Description
What does this change achieve?
Related Issues
What issue(s) does this change address?
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.