Would it be useful for the documentation to have some module dependency graphs?
For example, here's one for Unison.Codebase:
They're pretty easy to generate with graphmod. If you give me a list of folders you'd like graphs for and a place to put them (perhaps ./docs/generated) I'd be happy to make a script to do so.
You can embed them from there into ./docs documents, an ARCHITECTURE.md file, or wherever you want.
It might also be worth it to handwrite one showing how the subcomponents themselves depend on each other, eg parser, prettyprinter, typechecker, runtime, codebase, etc.
Would it be useful for the documentation to have some module dependency graphs?
For example, here's one for
Unison.Codebase
:They're pretty easy to generate with graphmod. If you give me a list of folders you'd like graphs for and a place to put them (perhaps
./docs/generated
) I'd be happy to make a script to do so.You can embed them from there into
./docs
documents, anARCHITECTURE.md
file, or wherever you want.