More docs#6
Merged
Merged
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
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 pull request significantly expands and clarifies the documentation for several ConTree CLI commands. The main improvements include the addition of detailed subcommand sections, more comprehensive usage explanations, and embedded help command outputs for easier reference. The documentation now better explains command behaviors, available flags, and expected outputs, making it more user-friendly for both new and experienced users.
Major documentation improvements:
Authentication commands (
auth):auth listsection to clarify aliases, status values, and the effect of the--offlineflag. Added embedded help output.auth switchexplaining how to change the active profile, with help output.auth removedocumentation to describe its behavior, confirmation, and side effects when removing the active profile. Added help output.File management commands (
file):file editandfile cpto clarify their behavior, aliases, and staging mechanism. Added help output for both.file ls.Image management commands (
images):images listandimages import.Operation management commands (
op):opis a dispatcher and added detailed sections forop list,op show, andop cancel, each with help output and explanation of dynamic columns and filtering. [1] [2] [3]Session management commands (
session):session list,use,branch,checkout,rollback,show,wait, anddelete, each with usage explanations and help outputs.Skill management commands (
skill):skill install,list,upgrade, andremove, including behavior, registry management, and help outputs.These changes greatly improve the discoverability and clarity of CLI features, making the documentation more actionable and easier to navigate for end users.