docs: replace TODO placeholders with API and SDK overview descriptions#5024
Merged
lzchen merged 2 commits intoopen-telemetry:mainfrom Mar 31, 2026
Merged
Conversation
|
|
tammy-baylis-swi
added
the
Skip Changelog
tammy-baylis-swi
approved these changes
Mar 30, 2026
lzchen
approved these changes
Mar 31, 2026
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
3 participants
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
Add overview descriptions to API and SDK documentation
Replace TODO placeholders in docs/api/index.rst, docs/sdk/index.rst, and docs/sdk/environment_variables.rst with concise descriptions explaining what the API and SDK are and their relationship to each other.
Fixes # (issue)
Type of change
How Has This Been Tested?
Does This PR Require a Contrib Repo Change?
Checklist: