docs: add pages for telemetry and the runtime modules, plus a source-to-sink quickstart#144
Merged
Merged
Conversation
Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
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.
What this change does
Adds documentation-site coverage for the modules that had none, and surfaces the runtime modules that were previously kept out of the public README:
telemetry(+ a slog/otel/datadog adapters page),durable,cluster,transport, andwasm.start/ingest-drive-emit.md): consume an event, drive a machine, emit an effect.astro.config.mjs): aTelemetrygroup and aRuntimesgroup (Durable/Cluster/Transport/WASM), viaautogenerate.experimentalrows fordurable/cluster/transport/wasm(thebroker"planned" row stays).Every code snippet was checked against the real exported signatures (
cluster.NewSystem/Capture/Restore,durable.NewRunner/Recover/StateAt,transport.DurableTimeTravel/StateAt,wasm.Compile/Guard,state.MarshalSnapshot/UnmarshalSnapshot,statemachine.Drive/NewMemStore,sink.NewManifold/WithOutlets).source/cdcwas already documented incodecs.md. Hero images are trackedIMAGE-SLOTplaceholders, not live tags, so nothing references a missing asset. Verified with a fullnpm run build(80 pages, no errors or broken-link warnings).Why
Four shipped modules were invisible to the docs site and absent from the README, and there was no quickstart spanning the IO seams. This makes the surface honest and navigable for the 1.0 cut.
Checklist
npm run buildclean