Welcome, wanderer! You are looking at the TigerBeetle's internal documentation. If you want to use TigerBeetle, you don't need to read this and could head straight to our user-level docs at

https://docs.tigerbeetle.com

If you want to learn how TigerBeetle works inside, here's what we got:

• TIGER_STYLE is the style guide, and more. This is the philosophy underlining all the code here!
• ARCHITECTURE is a one-page technical intro into TigerBeetle. If you are learning the codebase, start here.
• HACKING gets you up to speed with building the codebase and running the tests.
• Data File is a good second read. Following Fred Brooks' advice, it explains what data is stored where and why.
• VSR explains the upper consensus half of TigerBeetle.
  • Sync covers state synchronization for lagging replicas,
  • Upgrades are just so cool, you must read this!
• LSM covers the lower storage half.
• Releases is our release process.
• Talks is the list of talks about TigerBeetle so far!
• VOPR and testing cover the simulator.
• docs is our technical writing style guide.