docs: make crate READMEs consistent#3583
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
Co-authored-by: Utkarsh Umesan Pillai <66651184+utpilla@users.noreply.github.com>
|
@utpilla please re-review. Thanks! |
| *[Supported Rust Versions](#supported-rust-versions)* | ||
|
|
||
| [Prometheus]: https://prometheus.io | ||
| [Jaeger]: https://www.jaegertracing.io |
There was a problem hiding this comment.
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
left a comment
There was a problem hiding this comment.
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.
Revives #3074 to normalize the crate README structure (Overview / What does this crate contain? / Getting started / Release Notes / Supported Rust Versions). Fixes #1306.