Support for large projects

adr / madr

Markdown Architectural Decision Records

https://adr.github.io/madr/

Other

1.42k stars 402 forks source link

Support for large projects #10

Open koppor opened 6 years ago

koppor commented 6 years ago

One large repository

Add categories to the ADRs (refs https://github.com/adr/madr/issues/7), see also https://github.com/adr/madr/issues/122
Offer a web-based viewer

Several repositories

In addition

there is an overarching repository collecting the ADRs of the sub repositories using git submodules
there is a web-based tool for browsing.

tomlankhorst commented 6 years ago

In my opinion, a web-based tool for browsing already exists: markdown files will be automatically rendered in most online version control repositories. So this page is the web-based viewer for this project.

Furthermore, tools exist to automatically generate pages/sites from collections of markdown documents. For example, pandoc for straight-forward document conversions or site generators like Jekyll or HUGO.

thomvaill commented 3 years ago

As mentioned here, I developed a tool with a web UI and tags support for ADRs.

Log4brains is a docs-as-code knowledge base for your development and infrastructure projects. It enables you to write and manage Architecture Decision Records (ADR) right from your IDE, and to publish them automatically as a static website.

https://github.com/thomvaill/log4brains

I am looking for beta testers and any feedback will be very welcome! 🙏

Hnasar commented 2 years ago

Can't this be closed?

koppor commented 1 month ago

We described something in https://adr.github.io/madr/#using-madr-in-large-projects-and-product-developments.

We left it open as reminder to

provide examples / links to real-world cases
remind us for a tooling requirement.