casey / casey/just

Whole-file documentation

Open
#3,290 3 comments 4 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
35.8k
Forks
846
Avg merge
27m
Merged PRs (30d)
3

Description

It would be nice if there was a way to document the entire justfile and include it in `--list`, which would be helpful for overviews or mentioning how commands relate. For example:

```just
##! This handles the setup and running of foo. Note that commands bar
##! and baz interact, and if you run qux you will eventually later need to
##! run quux. If you are just getting started, you probably want corge.

# First recipe
default:
just --list

# ...
```

Could render as:

```text
$ just
This handles the setup and running of foo. Note that commands bar
and baz interact, and if you run qux you will eventually later need to
run quux. If you are just getting started, you probably want corge.

Available recipes:
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.