ipfs/kubo

Diagram of modules

Open

#2,452 opened on Mar 7, 2016

View on GitHub
 (10 comments) (0 reactions) (0 assignees)Go (13,906 stars) (2,725 forks)batch import
help wantedtopic/meta

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.

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

Tech stack
go
Domain
documentationdeveloper experience
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Familiarity with GoUnderstanding of IPFS architecture
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Review the go ipfs repository structure to identify major modules (e.g., core, commands, merkledag, etc.) and their communication patterns. Examine existing documentation and comments for data flow hints. The diagram should be easy to update, so consider using a tool like Mermaid or Graphviz. Check if there are any open PRs or discussions that provide partial blueprints.