ADRs have to be indexed somehow. E.g., for offering a web site showing all ADRs.
- Write the own tool
adr-log
- Use adr-tools' TOC functionality
Chosen option: Write own tool adr-log
, because
- we want to have the format
ADR-0001 - Title
in the TOC. - adr-tools offers
title
only.
We accept that changing adr-tools would also be possible. It is prepared to included header and footer: https://github.com/npryce/adr-tools/blob/master/tests/generate-contents-with-header-and-footer.sh.
adr-log
is installable usingnpm install -g adr-log
, which is easier than installingadr-tools
.
- Another tool has to be maintained