From b07203aea01cd35c81f8766628ebf8328694c7da Mon Sep 17 00:00:00 2001 From: Pratik Mankawde <3397372+pratikmankawde@users.noreply.github.com> Date: Tue, 22 Sep 2026 20:28:27 +0100 Subject: [PATCH] docs(telemetry): Use real line breaks in the span-link diagram labels Four labels in a flowchart wrote a backslash and an n to break a line. Mermaid has no escape for that, so it printed the two characters inside the node instead of wrapping. The labels are now markdown strings carrying a real line break, which also auto-wrap. The
tags elsewhere in these diagrams are left alone. Mermaid enables HTML labels by default and this repository overrides no Mermaid config, so they render correctly. --- OpenTelemetryPlan/00-tracing-fundamentals.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/OpenTelemetryPlan/00-tracing-fundamentals.md b/OpenTelemetryPlan/00-tracing-fundamentals.md index 1c7675243a..44ff504bcc 100644 --- a/OpenTelemetryPlan/00-tracing-fundamentals.md +++ b/OpenTelemetryPlan/00-tracing-fundamentals.md @@ -209,7 +209,9 @@ flowchart LR subgraph links["Span Links"] direction TB - X["Span X\n(Trace 1)"] -.-|link| Y["Span Y\n(Trace 2)"] + X["`Span X +(Trace 1)`"] -.-|link| Y["`Span Y +(Trace 2)`"] end parent_child ~~~ follows_from ~~~ links @@ -354,9 +356,11 @@ flowchart TB Fn["trace_id = f(ledger_hash)"]:::note --> F1["fetch.request"] --> F2["fetch.receive"] --> F3["fetch.apply"] end - C1 -.-|"span link\n(tx traces)"| T3 + C1 -.-|"`span link +(tx traces)`"| T3 C3 --> V1 - F1 -.-|"span link\n(target ledger)"| C3 + F1 -.-|"`span link +(target ledger)`"| C3 classDef note fill:none,stroke:#888,stroke-dasharray:5 5,color:#333,font-style:italic style T1 fill:#0d47a1,stroke:#082f6a,color:#ffffff