Closed matthchr closed 3 months ago
We already have guidance on writing an ADR - should we beef that up instead?
We already have guidance on writing an ADR - should we beef that up instead?
Hmm, I wasn't aware of that although I think the template solves a slightly different problem. Basically I wrote the template because I always find myself copying an existing ADR to write a new one and then just deleting the items in each section, which is what made me think a template would be useful.
Even now that I am aware of the instructions in _index.md
it's not actually markdown formatted so I can't easily just copy+paste it to get started.
What do you think about possibly...
Even now that I am aware of the instructions in _index.md it's not actually markdown formatted so I can't easily just copy+paste it to get started.
I've been just copying the bullet point list, change them to headings and work from there. A template would be easier.
What do you think about possibly...
Yeah, I like that approach.
I'll update the PR
I did the above, but realized that putting it into a folder doesn't actually make it less discoverable on the UI because folders and file are both just rendered as TOC entries, so I swapped to using toc_hide: true
instead, so the template is right there but it doesn't show up to readers of the site on the nav.
/ok-to-test sha=64c608b
Not sure if this is super useful or not, but I thought it might be so here it is.
If applicable: