Skip to content

Commit

Permalink
docs: update help documentation formatting
Browse files Browse the repository at this point in the history
- Removes unnecessary dollar sign from command examples for consistency.
- Adds markdownlint to the documentation generation script to ensure proper formatting.

Release-As: 0.0.1
  • Loading branch information
liblaf committed Nov 29, 2024
1 parent 852f390 commit 98892d3
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
**Usage**:

```console
$ llm-cli [OPTIONS] COMMAND [ARGS]...
llm-cli [OPTIONS] COMMAND [ARGS]...
```

**Options**:
Expand All @@ -21,7 +21,7 @@ $ llm-cli [OPTIONS] COMMAND [ARGS]...
**Usage**:

```console
$ llm-cli commit [OPTIONS] [PATH]...
llm-cli commit [OPTIONS] [PATH]...
```

**Arguments**:
Expand All @@ -39,7 +39,7 @@ $ llm-cli commit [OPTIONS] [PATH]...
**Usage**:

```console
$ llm-cli repo [OPTIONS] COMMAND [ARGS]...
llm-cli repo [OPTIONS] COMMAND [ARGS]...
```

**Options**:
Expand All @@ -56,7 +56,7 @@ $ llm-cli repo [OPTIONS] COMMAND [ARGS]...
**Usage**:

```console
$ llm-cli repo description [OPTIONS]
llm-cli repo description [OPTIONS]
```

**Options**:
Expand All @@ -68,7 +68,7 @@ $ llm-cli repo description [OPTIONS]
**Usage**:

```console
$ llm-cli repo topics [OPTIONS]
llm-cli repo topics [OPTIONS]
```

**Options**:
Expand Down
1 change: 1 addition & 0 deletions scripts/gen-help.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ set -o errexit -o nounset -o pipefail

typer llm_cli utils docs --output docs/help.md
prettier --write docs/help.md
markdownlint --fix docs/help.md

0 comments on commit 98892d3

Please sign in to comment.