Skip to content

docs: link example references to source files - #5581

Open
rkd-2004 wants to merge 1 commit into
open-telemetry:mainfrom
rkd-2004:docs/examples-scm-web-links
Open

docs: link example references to source files#5581
rkd-2004 wants to merge 1 commit into
open-telemetry:mainfrom
rkd-2004:docs/examples-scm-web-links

Conversation

@rkd-2004

Copy link
Copy Markdown

Description

Updated the example documentation to link references to example source files and configuration files using :scm_web: links.

This makes the example READMEs easier to navigate by allowing readers to directly open the referenced files in the repository.

Fixes #5427

Type of change

  • This change requires a documentation update

How Has This Been Tested?

The documentation changes were validated using:

  • git --no-pager diff --check
  • tox -e docs

The documentation build completed successfully with docs: OK.

Does This PR Require a Contrib Repo Change?

  • No.

Checklist:

  • Followed the style guidelines of this project
  • Documentation has been updated

@rkd-2004
rkd-2004 requested a review from a team as a code owner August 24, 2026 08:05
@linux-foundation-easycla

linux-foundation-easycla Bot commented Aug 24, 2026

Copy link
Copy Markdown

CLA Signed
The committers listed above are authorized under a signed CLA.

  • ✅ login: rkd-2004 / name: rkd-2004 (f1fbbd4)

@opentelemetry-pr-dashboard

opentelemetry-pr-dashboard Bot commented Aug 24, 2026

Copy link
Copy Markdown

Pull request dashboard status

Waiting on reviewers · refreshed 2026-08-24 08:54 UTC

Review the latest changes.

Status above doesn't look right?
  • Just replied or pushed? Anything around or after the refresh time above may not be picked up yet — give it a few minutes.
  • Anything look wrong? Report it with what you expected; it helps us improve the dashboard.

@rkd-2004
rkd-2004 force-pushed the docs/examples-scm-web-links branch from dea6bb9 to f1fbbd4 Compare August 24, 2026 08:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

docs: examples that references code should link to actual files in github

1 participant