search

getsentry / sentry-ruby

Sentry SDK for Ruby
https://sentry.io/for/ruby
MIT License
927 stars 486 forks source link

Add links to API docs in readme #2300

Closed st0012 closed 3 months ago

st0012 commented 3 months ago

While we've added quite extensive API docs to the SDK (at least to sentry-ruby), it's not easy to find them, which could contribute to misuses/confusion of APIs. Therefore, I think we should make the documentation more discoverable by linking them in the gems table.

And because the table already takes quite big of a space, I decided to remove the downloads column to make room for API doc links. I'm also ok with replacing the coverage column instead though.

For this initial improvement, I chose to use rubydoc.info as the source as it automatically fetches the gems' source and generate the content. I think ideally we can host them with GH pages with a automatic publishing workflow, which will give us more control (example: Ruby LSP). I think this is what sentry-rust does as well?

skip-changelog

codecov[bot] commented 3 months ago

Codecov Report

Merging #2300 (285bd15) into master (02538e4) will not change coverage. The diff coverage is n/a.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #2300 +/- ## ======================================= Coverage 98.71% 98.71% ======================================= Files 202 202 Lines 13282 13282 ======================================= Hits 13111 13111 Misses 171 171 ``` | [Components](https://app.codecov.io/gh/getsentry/sentry-ruby/pull/2300/components?src=pr&el=components&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=getsentry) | Coverage Δ | | |---|---|---| | [sentry-ruby](https://app.codecov.io/gh/getsentry/sentry-ruby/pull/2300/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=getsentry) | `99.09% <ø> (ø)` | | | [sentry-rails](https://app.codecov.io/gh/getsentry/sentry-ruby/pull/2300/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=getsentry) | `97.37% <ø> (ø)` | | | [sentry-sidekiq](https://app.codecov.io/gh/getsentry/sentry-ruby/pull/2300/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=getsentry) | `96.98% <ø> (ø)` | | | [sentry-resque](https://app.codecov.io/gh/getsentry/sentry-ruby/pull/2300/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=getsentry) | `96.76% <ø> (ø)` | | | [sentry-delayed_job](https://app.codecov.io/gh/getsentry/sentry-ruby/pull/2300/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=getsentry) | `98.91% <ø> (ø)` | | | [sentry-opentelemetry](https://app.codecov.io/gh/getsentry/sentry-ruby/pull/2300/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=getsentry) | `100.00% <ø> (ø)` | |