koppor
commented
4 years ago Thank you for the input and motivation. Think, this is a good thing for hacktoberfest. I'll try to create issues for it:
- [ ] IDE plugin to enable browsing of ADR
- [ ] JavaDoc plugin including the ADRs in the output
The first one was always on the wish list. However, we did not find the resources to implement it. In parallel, we crafted a project proposal for SCORE-2021: ADR Manager, because I see as main painpoint the addition of ADRs and getting the overview. I am aware that a web-based tool might not be used in IDEs. Possibly, we can embed it as plugin to the IDE.
This is an interesting idea, so kudos!
I indeed like the idea of the ADR linking annotation and having the ADR available in JavaDocs for developers browsing the code.
Would it be useful for the tool to consumer the ADR from an external markdown file (of whichever ADR format) and resolve the links when building JavaDoc?
This allows a single source of ADR (the markdown file) and does not need the ADR annotation (which feels awkward and bothersome).
An IDE plugin could even resolve links into ephemeral JavaDoc while the developer is browsing the code.
Cheers for advancing the ADR idea with this tool and your other works!