Skip to content

docs: make crate READMEs consistent#3583

Open
cijothomas wants to merge 4 commits into
open-telemetry:mainfrom
cijothomas:cijothomas/readme-consistency
Open

docs: make crate READMEs consistent#3583
cijothomas wants to merge 4 commits into
open-telemetry:mainfrom
cijothomas:cijothomas/readme-consistency

Conversation

@cijothomas

Copy link
Copy Markdown
Member

Revives #3074 to normalize the crate README structure (Overview / What does this crate contain? / Getting started / Release Notes / Supported Rust Versions). Fixes #1306.

@cijothomas
cijothomas requested a review from a team as a code owner July 6, 2026 01:30
@codecov

codecov Bot commented Jul 6, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.2%. Comparing base (4607956) to head (3020058).

Additional details and impacted files
@@          Coverage Diff          @@
##            main   #3583   +/-   ##
=====================================
  Coverage   83.2%   83.2%           
=====================================
  Files        130     130           
  Lines      28246   28246           
=====================================
  Hits       23506   23506           
  Misses      4740    4740           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment thread opentelemetry-appender-log/README.md Outdated
Co-authored-by: Utkarsh Umesan Pillai <66651184+utpilla@users.noreply.github.com>
Comment thread opentelemetry-prometheus/README.md Outdated
@cijothomas

Copy link
Copy Markdown
Member Author

@utpilla please re-review. Thanks!

*[Supported Rust Versions](#supported-rust-versions)*

[Prometheus]: https://prometheus.io
[Jaeger]: https://www.jaegertracing.io

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nit - I think these two links should be in all the READMEs. As of now they are missing for opentelemetry-appender-tracing and opentelemetry-jaeger-propagator.

@lalitb lalitb left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM. For future direction, it may be worth considering a small template/marker-based approach for the repeated README sections. Each crate README could still keep its crate-specific content, but shared sections like Overview and Supported Rust Versions could come from one source to avoid drift over time.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Consistent readme file for all components

3 participants