You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As written in the summary this repository “provides an initial directory structure and files to document Architectural Decisions using Markdown and Architectural Decision Records.”
The files (= the template) are explained in the README, the directory structure however is not. It's just presumed in the section Create a new ADR.
It would be nice to explain that the directory structure uses NNNN-title-with-dashes.md format and why it does so (other ADRs styles for example recommend using YYYY-MM-DD Title without Dahes or YYYY-MM-DD-title-with-dashes, so this difference should be explained somewhere).
The text was updated successfully, but these errors were encountered:
We removed the "initial directory structure" at 23a9277, because we want to use MADR for ourselves to document decisions taken at MADR. This update was missing updating the README.md completely. I fixed that in c62a716.
As written in the summary this repository “provides an initial directory structure and files to document Architectural Decisions using Markdown and Architectural Decision Records.”
The files (= the template) are explained in the README, the directory structure however is not. It's just presumed in the section Create a new ADR.
It would be nice to explain that the directory structure uses
NNNN-title-with-dashes.md
format and why it does so (other ADRs styles for example recommend usingYYYY-MM-DD Title without Dahes
orYYYY-MM-DD-title-with-dashes
, so this difference should be explained somewhere).The text was updated successfully, but these errors were encountered: