Skip to content

[DOCS] Note readthedocs bug in README#4054

Open
dyfrgi wants to merge 2 commits into
open-telemetry:mainfrom
dyfrgi:patch-1
Open

[DOCS] Note readthedocs bug in README#4054
dyfrgi wants to merge 2 commits into
open-telemetry:mainfrom
dyfrgi:patch-1

Conversation

@dyfrgi
Copy link
Copy Markdown

@dyfrgi dyfrgi commented May 5, 2026

Add a warning about #3059 to the docs link.

Changes

This does not fix #3059, but it adds a warning so that anyone following this link to the docs will know that they are out of date.

@dyfrgi dyfrgi requested a review from a team as a code owner May 5, 2026 16:51
@linux-foundation-easycla
Copy link
Copy Markdown

linux-foundation-easycla Bot commented May 5, 2026

CLA Not Signed

@dyfrgi
Copy link
Copy Markdown
Author

dyfrgi commented May 5, 2026

I'm working on the CLA with my employer.

@codecov
Copy link
Copy Markdown

codecov Bot commented May 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.04%. Comparing base (029f74e) to head (6ca9641).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #4054   +/-   ##
=======================================
  Coverage   82.04%   82.04%           
=======================================
  Files         385      385           
  Lines       15896    15896           
=======================================
  Hits        13040    13040           
  Misses       2856     2856           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@marcalff marcalff added the pr:waiting-on-cla Waiting on CLA label May 5, 2026
Copy link
Copy Markdown
Member

@marcalff marcalff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

To be revisited later once opentelemetry-cpp resolves how to publish up to date documentation.

@lalitb
Copy link
Copy Markdown
Member

lalitb commented May 6, 2026

#4058 should fix the docs. Thanks @dyfrgi for notifying the issue.

@ThomsonTan
Copy link
Copy Markdown
Contributor

#4058 should fix the docs. Thanks @dyfrgi for notifying the issue.

Seems we could leave this PR once #4058 is merged, or rephrase that the docs is only a reference and the repo docs is the source of truth.

@dyfrgi
Copy link
Copy Markdown
Author

dyfrgi commented May 6, 2026

#4058 should fix the docs. Thanks @dyfrgi for notifying the issue.

Seems we could leave this PR once #4058 is merged, or rephrase that the docs is only a reference and the repo docs is the source of truth.

Could we embed the docs CI status in the readme?

@marcalff
Copy link
Copy Markdown
Member

marcalff commented May 7, 2026

/easycla

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr:waiting-on-cla Waiting on CLA

Projects

None yet

Development

Successfully merging this pull request may close these issues.

rtd documentation is out of date

4 participants