docs: complete API and feature documentation - #124
Open
LimiNode wants to merge 4 commits into
Open
Conversation
Document OTLP, Prometheus, MDBX, MDC/NDC, packaging, queue semantics, and backend limitations in English and Russian guides. Include the new Markdown pages in Doxygen, exclude agent instructions, fix examples and Doxygen diagnostics, and make GitHub Pages publication deterministic with development version validation.
Correct the compile-time level examples, remove stale custom logger snippets, and align TaskExecutor wording with shared and backend-owned queues. Document the OTLP payload callback backend and Windows debugger logger, and strengthen generated documentation smoke checks for version, classes, excluded agent files, and legacy owner URLs.
LimiNode
force-pushed
the
docs/api-documentation-hardening
branch
from
September 7, 2026 11:05
a27ce07 to
ff585b6
Compare
Reflect the C++17 standard selected by the LOGIT_WITH_OTLP build option in the backend matrix for OtlpPayloadLogger.
Use the public WindowsDebugLogger class name in the English and Russian backend matrices so the platform overview matches the API and Doxygen group.
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\n- fix GitHub Pages publication and publish main documentation as 1.0.2-dev\n- include OTLP, Prometheus, TaskExecutor, and backpressure guides in Doxygen\n- exclude AGENTS.md, fix documented C++ snippets, and remove Doxygen warnings\n- document MDC/NDC, MDBX, packaging, backend matrix, platform limits, and async semantics\n\n## Validation\n\n- CMake configure/build passed\n- 56/56 tests passed\n- examples build passed\n- Doxygen 1.12.0 generation passed with no warnings/errors\n- generated docs smoke checks passed, including AGENTS.md exclusion\n\nFollow-up UX work (splitting the large mainpage and moving benchmark material) is intentionally out of scope for this PR.