Reinforce documentation for 32 remaining modules (90–95% API coverage, EN+RU)#65
Open
dsudomoin wants to merge 4 commits into
Conversation
…onfig, container docs Expanded EN docs to 90-95% public-API coverage and re-translated RU (EN/RU parity). Every documented API verified against Kora sources (branch 1.0 = 1.2.17). - gitignore .kora-agent (local Kora sources for verification) and .DS_Store
…racing, s3-client, openapi-codegen, mapstruct docs Expanded EN docs to 90-95% public-API coverage and re-translated RU (EN/RU parity). Every documented API verified against Kora sources (branch 1.0 = 1.2.17). - tracing: corrected exporter config to retryPolicy and OpentelemetryTracingModule - s3-client: fixed @bucket array syntax and testing link (junit5.md)
…eneral, junit5, logging-aspect, logging-slf4j, netty, openapi-management, probes docs Expanded EN docs to 90-95% coverage and re-translated RU (EN/RU parity). Every documented API verified against Kora sources (branch 1.0 = 1.2.17). - junit5/probes/logging-slf4j: removed hallucinated identifiers from frontmatter triggers - logging-aspect: added missing Kotlin tab for the StructuredArgument example - logging-slf4j: fixed Kafka config cross-links (config-consumer / config-producer)
…rtx, graalvm-native, soap-client docs Expanded EN docs to 90-95% coverage and re-translated RU (EN/RU parity). Every documented API verified against Kora sources (branch 1.0 = 1.2.17). Completes reinforcement of all 35 documentation modules. - camunda7-bpmn: frontmatter CamundaEngineConfig -> CamundaEngineBpmnConfig - database-vertx: removed non-existent @EntityVertx from frontmatter triggers - soap-client: corrected exception hierarchy (marshalling exceptions extend RuntimeException)
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
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
Reinforces the documentation for the 32 modules not yet covered, bringing each to 90–95% coverage of its public API, verified against the actual Kora sources (branch
1.0= release1.2.17). English is written/expanded first, then Russian is re-translated to keep strict EN/RU parity. Follows the existinghttp-server/http-client/kafkareinforcement pattern.What changed — 4 commits, 64 files (EN+RU)
Plus
.gitignore: ignore.kora-agent/(local Kora sources cloned for verification) and.DS_Store.How it was verified
Each module went through: gap analysis → write EN → independently verify that every documented class / interface / annotation / method / config key exists in the cloned Kora sources → correct or remove anything that doesn't → translate to RU → final QA.
The source-verification step corrected real inaccuracies before they shipped, e.g.:
tracing:exporter.retry→retryPolicy;TracingModule→OpentelemetryTracingModulecontainer:All<T>shown assealed … permits AllImplsoap-client: marshalling exceptions extendRuntimeException(notSoapException)s3-client:@Bucketarray syntax; corrected the testing link tojunit5.mdStructural invariants checked across all modules: EN/RU heading & anchor parity, paired Java/Kotlin tabs, balanced code fences, no Cyrillic in EN prose, all in-page and cross-file links resolve.
Style
Follows the reinforced reference docs: Java+Kotlin tabs for every API,
(required, no default)/(default: value)config style, Description + Causes + Recommendations for exceptions, no???+ tipblocks. All API claims are backed by Kora1.0(1.2.17) sources.