Skip to content

Remove non-functional bold tags from Mermaid code #93

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 28, 2024
Merged

Remove non-functional bold tags from Mermaid code #93

merged 1 commit into from
Feb 28, 2024

Conversation

per1234
Copy link
Collaborator

@per1234 per1234 commented Feb 28, 2024

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 mermaid code blocks of Markdown files).

The text in charts can be styled and formatted using HTML tags in the Mermaid code. Previously, <b> 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:

image

For this reason, the tags are hereby removed. No alternative is available. The <br /> tags continue to work as expected (though unfortunately the text is now left aligned image instead of being centered as before) so they are retained.

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.
@per1234 per1234 added type: imperfection Perceived defect in any part of project topic: documentation Related to documentation for the project labels Feb 28, 2024
@per1234 per1234 self-assigned this Feb 28, 2024
@per1234 per1234 merged commit ba8c07b into arduino:main Feb 28, 2024
@per1234 per1234 deleted the fix-chart branch February 28, 2024 15:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant