docs: add Docusaurus template documentation - #10
Merged
Conversation
Adds the Rust SDK template documentation, consumed by the apigear-docs site as a submodule (comparable to the other technology templates): an intro, a Cargo-based quick start, and per-feature pages for api, stubs, monitor, olink, mqtt, and nats. All snippets are grounded in the generated Hello World output, and the README's feature table links to the pages.
w4bremer
force-pushed
the
docs/template-docs
branch
from
June 1, 2026 19:05
69e288d to
73028a5
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
Adds the Docusaurus documentation for the Rust SDK template, consumed by the
apigear-docs site as a submodule
(
template-docs/template-rust) — comparable to the other technology templates.Authored with the technical-writer agent, grounded in the actual generated code
under
goldenmaster/tb_simple/and modeled on the C++17 template docs.Pages (
docs/docs/)intro.md— landing pagequickstart/index.md— Cargo-based quick start (shared_quickstart_common)features/features.md— overview (core: api/core/stubs; extended: monitor/olink/mqtt/nats/examples)features/api.md— traits,ApiFuture+_asynccompanion, the tokio-channelPublisher,ApiError, serde data typesfeatures/stubs.md— default implementations, workspace, examples, unit testsfeatures/monitor.md—tracingdecoratorfeatures/olink.md— ObjectLink adapters + simulation connectivityfeatures/mqtt.md— MQTT adapters (rumqttc)features/nats.md— NATS adapters (async-nats)Plus static assets (reused diagrams/logo) and the shared Hello World sample API.
Verified with
npm run buildin apigear-docs (no broken links, valid MDX).