docs: consolidate CLI documentation into cli_reference.md - #203
Merged
Conversation
Create docs/cli_reference.md as the single comprehensive CLI reference. Simplify getting-started.md and README.md to brief examples with links to the full reference. - Move detailed --ep, --optimize, and all flag documentation to cli_reference.md - Add missing flags: --static-cache, --max-seq-len, --ep, --runtime - Document all subcommands: build, build-gguf, list, info - Replace docs/cli.md with the new comprehensive reference - Update toctree in docs/index.md - Add cross-reference from ep_quickstart.md Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: Justin Chu <justinchu@microsoft.com>
Performance Comparison
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
There was a problem hiding this comment.
Pull request overview
Consolidates Mobius CLI documentation into a single canonical reference page and updates existing docs/README to link to it, reducing duplication and missing-flag drift across documentation.
Changes:
- Added a comprehensive CLI reference at
docs/cli_reference.mdcovering subcommands and flags. - Removed the older
docs/cli.mdpage and updated the docs toctree to point to the new reference. - Simplified CLI sections in
docs/getting-started.md,docs/ep_quickstart.md, andREADME.mdto quick examples + links.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/index.md | Updates the docs toctree entry from cli to cli_reference. |
| docs/getting-started.md | Replaces the long CLI section with a short quick start and link to the full reference. |
| docs/ep_quickstart.md | Adds a cross-reference to the full CLI reference for --ep options. |
| docs/cli_reference.md | New consolidated CLI reference for build, build-gguf, list, and info, including flags. |
| docs/cli.md | Removes the superseded CLI page. |
| README.md | Simplifies CLI examples and updates the docs site link to cli_reference.html. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Justin Chu <justinchuby@users.noreply.github.com>
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.
Create a single comprehensive CLI reference (
docs/cli_reference.md) that documents all subcommands and flags. Simplifygetting-started.mdandREADME.mdto brief examples with links to the full reference.Changes
docs/cli_reference.md— comprehensive reference for all CLI subcommands (build,build-gguf,list,info) and flagsdocs/cli.md— replaced by the new comprehensive referencedocs/getting-started.md— replaced detailed CLI section with quick start + linkREADME.md— brief CLI examples + link to referencedocs/index.mdtoctree to point tocli_referencedocs/ep_quickstart.mdwith cross-reference to CLI referenceMotivation
CLI documentation was duplicated across
cli.md,getting-started.md, andREADME.mdwith some flags (--static-cache,--max-seq-len,--ep,--runtime) missing from the originalcli.md. This consolidates everything into one authoritative source.