To try out ADR tools and generating a page to share with broader audience.
- Install
adr-tools2
in your mac (https://github.com/jpandres/adr-tools2) - Create ADR structure in your project
adr init
- Add a badge in your README.md like the one on top in this one. It will automatically get updated every time you run
adr new
(edit the link to your repo) - Setup github action to use
adr-viewer
and deploy generated HTML page to github pages.
ADRs sample from this project: https://jpandres.github.io/adrs/
Interesting links: