search

npryce / adr-tools

Command-line tools for working with Architecture Decision Records
Other
4.56k stars 580 forks source link

Improve documentation on TOC and Generate options #36

Closed jlo-photobox closed 6 years ago

jlo-photobox commented 6 years ago

I've been assessing the tool (great work!) and found that it took me a while to discover the format of the generate graph option. I had to run adr help generate graph in order to find it, but took me a while to realise that there was help for generate graph and generate toc independently.

Maybe split the actions into adr graph and adr toc?

npryce commented 6 years ago

I'm thinking I'll rename them to adr generate-graph and adr generate-toc. That is, have only one level of subcommand.

jmeijrink commented 6 years ago

It could also just be mentioned in adr help generate output that help for the specific commands can be requested as well.

npryce commented 6 years ago

I've improved the help text for adr generate to describe how to get help on using the generate subcommands.