docs(runtime): prefer ObserverRuntime examples#58
Merged
Conversation
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.
Description
This PR updates the public SOF docs to prefer the newer
ObserverRuntimecomposition style over the olderrun_async_*convenience wrappers.The existing snippets were still valid, but they no longer reflected the clearest public API for new users after the lifecycle/runtime work landed in
0.11.0. This PR makes the docs match the intended runtime surface.Changes
Detailed list of what changed:
crates/sof-observer/README.md: rewrote the runtime quickstart and plugin/extension examples to lead withObserverRuntime::new()docs/gitbook/crates/sof.md: updated the mainsofcrate page to show builder-style runtime compositiondocs/gitbook/getting-started/install-sof.md: updated starter snippets to useObserverRuntime::new()and attached hosts explicitlydocs/gitbook/getting-started/first-runtime.md: updated the progression and code samples to preferObserverRuntime + RuntimeSetupdocs/gitbook/use-sof/observer-service.md: updated the observer service example to use the composed runtime styledocs/gitbook/use-sof/observe-and-submit-service.md: updated the combined observe-and-submit example to useObserverRuntimedirectlyFor slice-related changes, include:
Motivation
Business motivation:
Technical motivation:
ObserverRuntimeis now the clearer top-level public style for runtime compositionwith_setup(...),with_plugin_host(...), andrun_until_termination_signal()instead of older wrapper functionsAlternative approaches considered:
ObserverRuntimeas a secondary note instead of making it the primary documented pathScope and impact
Testing
Commands/results:
Related issues and documentation
docs/architecture/README.mdReviewer checklist
docs/architecture/ard/0003-slice-dependency-contracts.md)Additional notes
run_async_*entrypoints are still valid convenience wrappers.