Skip to content

Reinforce documentation for 32 remaining modules (90–95% API coverage, EN+RU)#65

Open
dsudomoin wants to merge 4 commits into
kora-projects:feature/docs-reinforced-planfrom
dsudomoin:feature/docs-reinforced-plan-danill
Open

Reinforce documentation for 32 remaining modules (90–95% API coverage, EN+RU)#65
dsudomoin wants to merge 4 commits into
kora-projects:feature/docs-reinforced-planfrom
dsudomoin:feature/docs-reinforced-plan-danill

Conversation

@dsudomoin

Copy link
Copy Markdown
Contributor

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 = release 1.2.17). English is written/expanded first, then Russian is re-translated to keep strict EN/RU parity. Follows the existing http-server / http-client / kafka reinforcement pattern.

What changed — 4 commits, 64 files (EN+RU)

  • grpc-server, grpc-client, database-jdbc, database-r2dbc, config, container
  • json, validation, cache, resilient, scheduling, metrics, tracing, s3-client, openapi-codegen, mapstruct
  • database-cassandra, database-common, database-migration, general, junit5, logging-aspect, logging-slf4j, netty, openapi-management, probes
  • camunda7-bpmn, camunda7-rest, camunda8-worker, database-vertx, graalvm-native, soap-client

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.retryretryPolicy; TracingModuleOpentelemetryTracingModule
  • container: All<T> shown as sealed … permits AllImpl
  • soap-client: marshalling exceptions extend RuntimeException (not SoapException)
  • s3-client: @Bucket array syntax; corrected the testing link to junit5.md
  • removed hallucinated identifiers from a few frontmatter trigger lists (junit5, probes, logging-slf4j, database-vertx, camunda7-bpmn)

Structural 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.

Note: mkdocs build --strict was not run (mkdocs not available in the authoring environment); links/anchors/tabs were validated by hand. A --strict build in CI is recommended as a final check.

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 ???+ tip blocks. All API claims are backed by Kora 1.0 (1.2.17) sources.

dsudomoin added 4 commits July 2, 2026 18:14
…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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant