Has any of you guys done this in a blog / static website like context?
I got myself a static website with jekyll. Haven't included a template of ADR yet (just opened a ticket after reading this post), but explanations to the why of decisions made. In consequence, using github pages or something similiar the ADR is next to the git repository and nicely readable.
Because of jekyll's overhead files the documentation repository is a submodule of the code base.
After reading the MADR approach, the website is clearly a bit more overhead and could lead to a discussion whether the accessibility of a html page instead of md files is worth the hassle.
I just open-sourced a project that let's you publish your ADRs as a static website:
Log4brains - github.com/thomvaill/log4brains
This is a CLI + web UI that lets you manage and publish your ADRs from Markdown to a static website, with search, history flow graph and other useful features.
This is a beta, so your feedback is very welcome!
For further actions, you may consider blocking this person and/or reporting abuse
We're a place where coders share, stay up-to-date and grow their careers.
Has any of you guys done this in a blog / static website like context?
I got myself a static website with jekyll. Haven't included a template of ADR yet (just opened a ticket after reading this post), but explanations to the why of decisions made. In consequence, using github pages or something similiar the ADR is next to the git repository and nicely readable.
Because of jekyll's overhead files the documentation repository is a submodule of the code base.
After reading the MADR approach, the website is clearly a bit more overhead and could lead to a discussion whether the accessibility of a html page instead of md files is worth the hassle.
I just open-sourced a project that let's you publish your ADRs as a static website:
Log4brains - github.com/thomvaill/log4brains
This is a CLI + web UI that lets you manage and publish your ADRs from Markdown to a static website, with search, history flow graph and other useful features.
This is a beta, so your feedback is very welcome!