Skip to content

Difficulty finding integration-specific information in docs #12359

Open
@mattico

Description

SDK

All SDKs

Description

Your docs seem to merge the integration-level docs (e.g. Node.js) with the platform-level docs (e.g. JavaScript). I can understand the benefits of that - if one is writing a Node.js app there's just one place to look for docs which has everything you need. However, when I'm trying to find information specific to the integration it can get in the way.

For example, right now I'm trying to answer the question "will Errors captured by logger.LogError(ex) in Sentry.Extensions.Logging be related to the currently executing span, or do I need to use logger.BeginScope, or something else?" This is a question related to the specific integration, generic .NET platform docs probably won't help. The integration root doc didn't answer my question. So I search and browse through the rest of the docs trying to find if there is any more information about the Microsoft.Extensions.Logging integration, and find nothing, because they're all generic platform-level docs.

I've also felt this with other integrations I've used - Vue and Node.js - at times. I have an app which has a Vue frontend and Node.js backend. First I added sentry to the backend, then to the frontend. When working on the frontend sentry integration I already knew how the Sentry JavaScript platform worked generally, I just needed to learn about anything which was special about the Vue integration. I found myself opening the Vue and Node.js docs side-by side and mentally diffing them to see what I needed to do differently this time.

Suggested Solution

Personally, I'd prefer if the docs were strictly hierarchical. Strictly separate Sentry docs, Platform docs, and Integration docs. But I get that something is lost by doing that and I may think differently from others.

Perhaps integration-specifc (and platform-specific?) docs could be highlighted somehow? Integration-specific pages could have a tag in the sidebar. Integration-specific blocks within pages which are mostly platform-generic could have a callout?

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    • Status

      Waiting for: Support

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions