Skip to content

Commit c9459a7

Browse files
committed
Remove non-functional bold tags from Mermaid code
In order to make it easier for the reader to understand the function of complementary example workflows provided in the FAQ, a chart is used to explain the flow of sketches report data between the steps and jobs in the sketch compilation workflow and between the sketch compilation workflow and the deltas report workflow. The Mermaid diagramming language is used to produce this flowchart (GitHub automatically renders Mermaid code in code blocks of Markdown files). The text in charts can be styled and formatted using HTML tags in the Mermaid code. Previously, bold tags were used on the subgraph titles in order to improve the readability of the chart. Since the time the chart was created, something changed in GitHub's Markdown/Mermaid rendering system that causes these tags to no longer cause the intended text styling. They now are simply printed as text, meaning they now have a harmful effect on the readability. For this reason, the tags are hereby removed. No alternative is available. The line break tags continue to work as expected (though unfortunately the text is now left aligned instead of being centered as before) so they are retained.
1 parent 1b6a710 commit c9459a7

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

Diff for: docs/FAQ.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ flowchart TB
9494
subgraph main[" "]
9595
direction TB
9696

97-
subgraph compileWorkflow["<b>Sketch compilation workflow run</b>"]
97+
subgraph compileWorkflow["Sketch compilation workflow run"]
9898
direction TB
9999

100100
unoJob["arduino:avr:uno<br />job"]
@@ -113,13 +113,13 @@ flowchart TB
113113
mkrzeroArtifact["sketches-reports-arduino-samd-mkrzero<br />artifact"]
114114
end
115115

116-
subgraph reportWorkflow["<b>Size deltas report workflow run</b>"]
116+
subgraph reportWorkflow["Size deltas report workflow run"]
117117
direction TB
118118

119119
reportAction["arduino/report-size-deltas<br />action"]
120120
end
121121

122-
subgraph pr["<b>Pull request</b>"]
122+
subgraph pr["Pull request"]
123123
direction TB
124124

125125
comment["Size deltas report<br />comment"]

0 commit comments

Comments
 (0)