ipfs / ipfs/kubo

Diagram of modules

Open
#2,452 10 comments 0 reactions 0 assignees View on GitHub
help wanted topic/meta
Dominant language
Go
Stars
17.1k
Forks
3.2k
Avg merge
3d 18h
Merged PRs (30d)
11

Description

go-ipfs is big project. My biggest struggle while getting into it was finding my way through it.

A diagram of modules, how they communicate, in which directories they are contained and they functionalities, possibly with data flow paths would be great "getting into" helper.

cjdns has very basic version of that but it lacks a lot (also its codebase is much smaller and more consistent, it is C after all) other info that would be useful.

![](https://raw.githubusercontent.com/cjdelisle/cjdns/master/doc/CjdnsModules.png)

It also should be easy to update so it doesn't stall as it did in case of cjdns. There were some changes made that were never included into this diagram.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.