3 ms·
> If you maintain an open-source project in the range of 10k-200k lines of code, I strongly encourage you to add an ARCHITECTURE document I like this idea but
by hbcondo714 3y ago
> If you maintain an open-source project in the range of 10k-200k lines of code, I strongly encourage you to add an ARCHITECTURE document
I like this idea but IMHO, regardless of repo size, architecture can still has some place in a Readme. For example, I purposely placed a Mermaid sequence diagram[1] in the main Readme because I think it's important that all readers see and understand its workflow[2]
[1] https://mermaid.js.org/syntax/sequenceDiagram.html https://mermaid.js.org/syntax/sequenceDiagram.html
[2] https://github.com/hbcondo/revenut-app?tab=readme-ov-file#-workflow https://github.com/hbcondo/revenut-app?tab=readme-ov-file#-w...
- yawgmoth 3y agoA natural language mermaid diagram builder would be really neat. Something to go think about...