Skip to content

Transform attribute mentions into DocC symbols #20

@slashmo

Description

@slashmo

Introduction

OpenTelemetry's semantic conventions have a lot of documentation paragraphs that mention other attributes, for example this line from http.request.header:

The User-Agent header is already captured in the user_agent.original attribute.

Proposed Feature

A nice UX improvement for our generated documentation could be to link to transform these attribute mentions into actual Swift symbol references, i.e.

/// The `User-Agent` header is already captured in the ``OTelAttribute/userAgent/original`` attribute.

... for the OTelAttribute documentation and ...

/// The `User-Agent` header is already captured in the ``Tracing/SpanAttributes/UserAgentAttributes/NestedSpanAttributes/original`` attribute.

... for the SpanAttributes documentation.

Proposed Solution

This feature can likely be built on top of @NeedleInAJayStack's excellent work in #19, which already collects the connection between OTel attribute names and generated Swift symbol names into a Context type.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions