File 2412-Fix-Markdown-docs-mostly-tables-some-garbled-some-ha.patch of Package erlang
From 9a17ffc31cde0b3a0f41df81313322fc5186b95c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?H=C3=A5kan=20Stenholm?=
<hokan.stenholm@erlang-solutions.com>
Date: Wed, 27 Aug 2025 16:07:28 +0200
Subject: [PATCH] Fix Markdown docs - mostly tables (some garbled some hard to
read)
* lib/eunit/doc/guides/chapter.md - fix garbled table
* lib/edoc/doc/guides/chapter.md - fix garbled tables
* lib/crypto/doc/guides/algorithm_details.md - fix hard to read table
* system/doc/efficiency_guide/profiling.md - fix hard to read table
* lib/ssl/doc/guides/standards_compliance.md - restore bolded subsections
* system/doc/reference_manual/expressions.md - add some links in table
* system/doc/reference_manual/typespec.md - add some links in table
* system/doc/design_principles/included_applications.md
- improve visuals of Mermaid diagram
* lib/megaco/doc/guides/megaco_architecture.md
- improve readability of Mermaid diagram
---
lib/crypto/doc/guides/algorithm_details.md | 30 +++--
lib/edoc/doc/guides/chapter.md | 73 +++++++----
lib/eunit/doc/guides/chapter.md | 15 ++-
lib/megaco/doc/guides/megaco_architecture.md | 29 ++++-
lib/ssl/doc/guides/standards_compliance.md | 122 +++++++++---------
.../included_applications.md | 64 +++++----
system/doc/efficiency_guide/profiling.md | 14 +-
system/doc/reference_manual/expressions.md | 4 +-
system/doc/reference_manual/typespec.md | 56 ++++----
9 files changed, 243 insertions(+), 164 deletions(-)
diff --git a/lib/megaco/doc/guides/megaco_architecture.md b/lib/megaco/doc/guides/megaco_architecture.md
index 81ec9a6ad3..b112432632 100644
--- a/lib/megaco/doc/guides/megaco_architecture.md
+++ b/lib/megaco/doc/guides/megaco_architecture.md
@@ -42,8 +42,16 @@ used underneath.
title: Network architecture
---
-flowchart LR
- telco_network("PSTN<br />ATM<br />etc.") <--SS7 etc.--> signal_gw[Signaling Gateway]
+flowchart TB
+ %% Pad text (first/longest line) in node, with non-breaking spaces.
+ %% This is done to force the node circle to be big enough, to fit it's text inside the circle.
+ telco_network((" PSTN <br />ATM<br />etc.")) <--SS7 etc.--> signal_gw[Signaling Gateway]
+
+ %% Alt: box with rounded left & right corners, the narrow text makes the node eliptic,
+ %% slightly taller than wide
+ %% telco_network(["PSTN<br />ATM<br />etc."]) <--SS7 etc.--> signal_gw[Signaling Gateway]
+
+
signal_gw <--Sigtran--> mgc[Call Agent<br /><br /><br />Media Gateway Controller]
telco_network <--Trunks--> trunk_gw[Trunking<br />Media Gateway]
mgc --Megaco/H.248--> trunk_gw
@@ -52,6 +60,23 @@ flowchart LR
lines_gw --> phone2[📞 phone 2]
lines_gw --> phone3[📞 ...]
mgc --Megaco/H.248--> ip_phone_gw[IP Phone Media Gateway]
+
+ %% Note: edges are numbered by the order they are introduced
+ %% SS7
+ linkStyle 0 stroke-width:5px;
+ %% Sigtran
+ linkStyle 1 stroke-width:3px;
+ %% Trunks
+ linkStyle 2 stroke-width:5px;
+ %% Megaco
+ linkStyle 3 stroke-width:3px;
+ linkStyle 4 stroke-width:3px;
+ %% phone
+ linkStyle 5 stroke-width:1px;
+ linkStyle 6 stroke-width:1px;
+ linkStyle 7 stroke-width:1px;
+ %% Megaco
+ linkStyle 8 stroke-width:3px;
```
Megaco and peer protocols are complementary in nature and entirely compatible
--
2.51.0
