Skip to content

Commit

Permalink
chore: update to CLI doc contrib guide
Browse files Browse the repository at this point in the history
Signed-off-by: Eric Gregory <eric@cosmonic.com>
  • Loading branch information
ericgregory authored and vados-cosmonic committed Oct 10, 2024
1 parent f19c6bd commit 483acd8
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/contributing/documentation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ npm run serve

## Generating CLI documentation

The [command-line documentation](/docs/cli/) at [`docs/cli/index.mdx`](https://github.com/wasmCloud/wasmcloud.com/tree/main/docs/cli) is generated using the `--help-markdown` argument with `wash`. An easy way to run the command is `wash app list --help-markdown > help.md`. Once you've generated CLI documentation, copy the contents to the `index.mdx` file linked above. Note that you will need to place some angle brackets within backticks (&#96;) for the page to render correctly.
The [command-line documentation](/docs/cli/) at [`docs/cli/index.mdx`](https://github.com/wasmCloud/wasmcloud.com/tree/main/docs/cli) is generated using the `--help-markdown` argument with `wash`. An easy way to run the command is `wash app list --help-markdown > help.md`. Once you've generated CLI documentation, copy the contents to the `index.mdx` file linked above.

## Making a pull request

Expand Down

0 comments on commit 483acd8

Please sign in to comment.