1. Usage guides
| Document | What it covers |
|---|---|
| API guide | Initialization, writes, WriteSession, flush and receive callbacks |
| Integration | Local source, CMake and installed packages |
| Async logging example | Passing log records in an application |
| Example index | Complete examples by use case |
| Detailed introduction | Performance questions, two-layer design and use cases |
2. Performance reports
| Directory | Contents |
|---|---|
| reports/ | Report entry point and main comparisons |
reports/comparison/ |
Ordinary writes, WriteSession and upstream queue comparisons |
reports/burst/ |
Business performance after a continuous message batch |
reports/block_size/ |
Block-size sweeps and publication strategies |
reports/analysis/ |
Cache, latency and implementation investigations |
| Methodology | Metrics, test conditions and reproduction |
Original measurements remain in performance_data/. Source views remain in code/.
3. Development and publication
| Document | Contents |
|---|---|
| Testing | Functional tests, benchmark contracts and integration checks |
| Publication contents | Files included in the publication tree |
| Publishing | GitHub repository, Pages and bilingual packages |
| Contributing | Proposing code and documentation changes |
| Test index | Tests grouped by component |
| Bundled comparison queues | Fixed versions, original licenses and offline builds |
| Benchmark index | Performance experiments and parameter searches |