search

npryce / adr-tools

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

fix custom template instructions #45

Closed martinklepsch closed 6 years ago

martinklepsch commented 6 years ago

Just noticed that there's a small mismatch between implementation + documentation.

Wording could be done differently but I figured this is probably clearer than saying "if there's a directory templates/ and a file template.md in this directory it is used..."

Maybe also the implementation is wrong and the docs are correct? 😆

koppor commented 6 years ago

At https://github.com/npryce/adr-tools/pull/43 we added a custom template, which was more work, because we define headings and links in a slightly different way.

We also improved the finding of templates at https://github.com/npryce/adr-tools/pull/43/files#diff-f72c445542852eb903c03519fa554d54R80 First, the sub directory templates of the ADRs is checked, then ADR dir itslef, then the adr_template_dir.

npryce commented 6 years ago

Yes, I prefer this wording.