cursus

📚 Project Documentation

This directory contains various documents explaining different aspects of the project. Please navigate through the list below to find the information you need.

📖 Core Document Index

• Architecture – Overall design and architectural plan.
• Core – Core components overview, including message flow and server handling.
  • Message Flow – How messages travel through the broker system.
  • Server – Server implementation, connection handling, and concurrency model.
  • Storage
    • Disk Format – On-disk data structures.
    • Disk Persistence – Data persistence and durability mechanisms.
    • Platform Optimizations – Platform-specific optimizations.
    • Segment Management – Segment handling, rolling, and cleanup.
  • Topic
    • Consumer Groups – Management and coordination of consumer groups.
    • Topic Management – Creation, deletion, and configuration of topics.
    • Topics and Partitions – Partitioning and topic-to-partition mapping.
• User Guide – Introduction and guidance on installation, configuration, and using the broker.
  • Installation – Step-by-step installation instructions.
  • Configuration – Configuration options and settings.
• Reference
  • API Reference – Complete API documentation.
  • Benchmark – Performance benchmark results and testing methodology.
  • Command Interface – CLI commands and usage.
  • Observability – Metrics, logging, and monitoring.
  • Performance – Performance tuning and optimization strategies.
• Contributing – Guidelines for contributing to the project and documentation.

📝 Contribution and Maintenance

We welcome any contributions or suggestions to improve our documentation. Please refer to the respective links for detailed information.

• To add new documentation or suggest improvements to existing files, please create a Pull Request.

This site is open source. Improve this page.