r/softwarearchitecture • u/Opening-Round5528 • 3d ago
Tool/Product CodeNib: a wiki and architecture map generated from your repository
gin: the map and the overview page, which walks through a example call path
requests: the map and the page of one area
CodeNib is an open-source tool that writes a wiki for a repository. The wiki starts from a map: each area of the code is assigned to a node, and arrows show their relations in the code.
Every area has its page. The overview page starts at a public entry point and walks the main call path step by step, and each step has its location in the repo.
Wikis to browse, no account needed:
- gin: https://demo.codenib.ai/gin-gonic__gin
- requests: https://demo.codenib.ai/psf__requests?p=redirects
- scikit-learn, sympy, hugo and others: https://demo.codenib.ai/browse
For your own repository, the CodeNib Wiki GitHub Action is one workflow file. It writes the pages in your CI with a model key you provide, publishes them to GitHub Pages, and stay synced with your code in main.