docs: use titles for more code blocks

[HonkingGoose]

Changes

• Use titles for more code blocks
• Other small style fixes

Context

Change code blocks so they show the file name or description of the content.

Some introductory text for code blocks is too long or complex to put in the title="", so I did not change those. 😄

Read the Material for MkDocs, adding a title to code blocks to learn more, and to see an example.

Follow-up PR after:

• docs(opentelemetry): add title to code blocks #25496

Documentation (please check one with an [x])

• I have updated the documentation, or
• No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

• Code inspection only, or
• Newly added/modified unit tests, or
• No unit tests but ran on a real repository, or
• Both unit tests + ran on a real repository

[rarkins]

How do these look when viewed in "preview" form on GitHub?

[HonkingGoose]

How do these look when viewed in "preview" form on GitHub?

GitHub does not show the title in the codeblock. So the published docs look better, but the "nice GitHub preview of the Markdown file" gets broken. When you view the raw file or go into the edit mode, you'll see the titles of course.

[rarkins]

@viceice @secustor wdyt?

[secustor]

As long we only do it for user docs the broken preview is fine for me.

[renovate-release]

🎉 This PR is included in version 37.43.1 🎉

The release is available on:

• GitHub release
• 37.43.1

Your semantic-release bot 📦🚀