feat(docs): Add comprehensive CLI documentation suite #301
+2,173
−118
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
|
|
||
| ### Ion Data Format | ||
| Fusion uses Amazon Ion as its data format: | ||
| Fusion uses [Amazon Ion](https://ion-fusion.dev/) as its data format: |
There was a problem hiding this comment.
Sorry for the unclear comment -- I mean we should link to the Amazon Ion official site (i.e https://amazon-ion.github.io/ion-docs/) not the Fusion one
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.
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?
|
@mtorres11 So sorry, Marco! For some reason this PR isn't showing up in my Arc PR folder and I lost track of it. I've got a bunch of feedback drafted earlier that I'll clean up and send today. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.