Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move docs from readme to docs.rs #2341

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

cijothomas
Copy link
Member

Continuing from #2336.
Part of #1306

Removes docs from the github readme.md file and moves everything into the docs.rs.
Readme.md is what gets rendered in crates.io, so I'd like to get some feedback from others on how much info we need to put there vs docs.rs...
We want to avoid duplicating information as much as possible.

Copy link

codecov bot commented Nov 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.5%. Comparing base (9a85ce1) to head (a01fd67).

Additional details and impacted files
@@          Coverage Diff          @@
##            main   #2341   +/-   ##
=====================================
  Coverage   79.5%   79.5%           
=====================================
  Files        123     123           
  Lines      21365   21365           
=====================================
  Hits       17004   17004           
  Misses      4361    4361           

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

opentelemetry/src/lib.rs Outdated Show resolved Hide resolved
@hdost
Copy link
Contributor

hdost commented Nov 26, 2024

I feel like at least for the main opentelemetry it is good to have a more comprehensive page. Giving a good intro before needing to drop into the docs directly.

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.

2 participants