docs(opentelemetry): add title to code blocks #25496
Merged
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.
Changes
Context
Material for MkDocs can show a filename or title in the codeblock. I think this looks better than having the filename "floating above" the corresponding code block.
When you view the file on GitHub the "nice preview" does not show the title. So we're trading a nicer look in the published doc, for a worse experience when browsing the Markdown files on GitHub. In the edit mode or raw mode you'll see the title in the code block, because you're looking at the plain text.
We should first try this on a single page, if it breaks it's easy to revert.
Let me know if you want me to go through the docs and put all the filenames in the code blocks (once we're sure it works properly)? 馃槈
Documentation (please check one with an [x])
How I've tested my work (please select one)
I have verified these changes via: