I understand that adr generate toc outputs its content to stdout for deployment scriptability.
But on the other hand, I like adr-log's -i parameter which generates directly the index.md file.
I propose to create a new command: adr generate index which accepts the same parameters as adr generate toc.
This command would call _adr_generate_toc and _adr_dir to create an index.md directly in the adr directory.
For small projects, when you don't want to setup deployment scripts for your doc, I think it simplifies the process:
adr new ...
adr generate index
git commit
versus:
adr new ...
adr generate toc > docs/adr/index.md
git commit
Eventually, you can add adr generate index to a pre-commit hook ;)
If you are OK with this issue, I can work on a pull request.
I understand that
adr generate toc
outputs its content to stdout for deployment scriptability. But on the other hand, I like adr-log's-i
parameter which generates directly theindex.md
file.I propose to create a new command:
adr generate index
which accepts the same parameters asadr generate toc
. This command would call_adr_generate_toc
and_adr_dir
to create anindex.md
directly in the adr directory.For small projects, when you don't want to setup deployment scripts for your doc, I think it simplifies the process:
versus:
Eventually, you can add
adr generate index
to a pre-commit hook ;)If you are OK with this issue, I can work on a pull request.