Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 thecoverage
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 whatsentry-rust
does as well?#skip-changelog