docs: reorganize guide and benchmark documentation - #125
Merged
Conversation
LimiNode
force-pushed
the
docs/information-architecture
branch
4 times, most recently
from
September 7, 2026 15:48
38cf8c4 to
4da5663
Compare
This was referenced Sep 7, 2026
LimiNode
changed the base branch from
docs/api-documentation-hardening
to
main
September 10, 2026 22:17
Split the Doxygen landing page from the detailed API reference and add focused quick-start, backend, and benchmark guides. Extend publication checks to cover the new pages and validate generated local links.
Document shared OTLP dependencies and asynchronous payload delivery, centralize backend and benchmark references, and add a complete installation guide. Validate documentation on pull requests with dynamic version checks.
Update queue configuration examples to use the stable logit::QueuePolicy name introduced by the API cleanup.
Make logit.hpp the supported application entry point and document that log_macros.hpp is aggregate-owned without a standalone inclusion guarantee. Keep standalone contracts explicit for public type headers.
Describe the distinct MPSC DropOldest semantics and represent LogRecord::format as a format field in both README variants.
Use the supported umbrella entry point in Prometheus examples and avoid implying standalone contracts for aggregate-owned headers or public aliases.
LimiNode
force-pushed
the
docs/information-architecture
branch
from
September 10, 2026 22:17
34dd54b to
94199f2
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary\n- split the concise Doxygen landing page from the detailed API reference\n- add dedicated quick-start, backend matrix, and benchmark guides\n- centralize benchmark methodology and add publication smoke/link checks\n\n## Validation\n- Doxygen 1.12.0 generation succeeds without warnings\n- generated page/link smoke checks pass locally\n\nThis PR is intentionally stacked on the documentation hardening changes in #124.