4 ms·
I experimented with something similar in one of my larger side projects a couple of years ago: https://github.com/shipmight/shipmight/blob/master/src/ARCHITECT
by marttilaine 3y ago
I experimented with something similar in one of my larger side projects a couple of years ago:
https://github.com/shipmight/shipmight/blob/master/src/ARCHITECTURE.md https://github.com/shipmight/shipmight/blob/master/src/ARCHI...
At the top of each file there was a tree of links to other ARCHITECTURE.md-files in the repo, like this:
* ARCHITECTURE.md <- you are here
* backend/ARCHITECTURE.md
* backend/api/ARCHITECTURE.md
* backend/cli/ARCHITECTURE.md
* backend/ui/ARCHITECTURE.md
* backend/utils/ARCHITECTURE.md
* frontend/ARCHITECTURE.md
* internal-charts/ARCHITECTURE.md
- rzzzt 3y agoA README.md in each package/module/top-level directory is also rendered by GitHub's UI in the file list at the bottom (in locations like this: https://github.com/shipmight/shipmight/tree/master/src/backend https://github.com/shipmight/shipmight/tree/master/src/backe...), I've seen this in some projects as well.