docs: Update the CLI documentation #571
Conversation
Add `mdsh` directive to the cli documentation, to make it easier to keep in sync. How to run: ``` nix run n#mdsh -- --inputs ./docs/cli.md ```
| @@ -1,14 +1,19 @@ | |||
| # CLI | |||
|
|
|||
| <!-- `$ nix run . -- --help` --> | |||
There was a problem hiding this comment.
It's in the commit message. It's to easily keep the cli documentation up to date.
There was a problem hiding this comment.
Does that mean running the command in the commit message will automatically update this file?
We already have mdsh configured under treefmt so does that mean our checks.<system>.treefmt will now error if it's out of date?
There was a problem hiding this comment.
Does that mean running the command in the commit message will automatically update this file?
Yes, running the command will automatically update the file and keep it up to date.
We already have mdsh configured under treefmt so does that mean our checks..treefmt will now error if it's out of date?
No, and we could remove mdsh from treefmt as it seems unused to me.
But we could set it up to error if it's out of date.
Closes: #410