-
Notifications
You must be signed in to change notification settings - Fork 5
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed
Description
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-Agentheader is already captured in theuser_agent.originalattribute.
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.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed