Back to docsSource reading
Source reading path
A reading order for the codebase, plus the two source-analysis books.
Repository doc · GitHub · docs/book
Outline
Start with shared models in common, then follow the broker flow, then go into store.
registry and rpc can be read separately once the message flow is clear.
Related module
docs/ · learn/
Reading notes and the book index.
Start here in the repository.
Related docs
ArchitectureSite summary
After a from-scratch rewrite, why stay compatible with RocketMQ
A rewrite was about redrawing boundaries, not abandoning the ecosystem. Why compatibility is the migration path, and what it costs inside the code.
docs/ · architecture/
StorageSite summary
Inside CommitLog sharding: where 5x throughput comes from
A walk through the write path: the global lock, how shards and offset encoding work, what dispatch decoupling changes, and when the 5x figure applies (project self-test).
store/ · commitlog/
ArchitectureRepository doc
Architecture overview
How the modules are split, what runs where, and where this fork differs from RocketMQ.
docs/ · broker/