1855165 - Use MermaidJS to replace ASCII based Inspector architecture diagram

Status: RESOLVED FIXED

(DevTools :: Documentation, task)

Description

[Jan Honza Odvarko [:Honza] (always need-info? me)]

Attachment: obrazek.png

The Inspector architecture diagrams are ASCII based, we can do much better job and simplify the maintenance using MermaidJS
https://mermaid.js.org/syntax/flowchart.html

The docs page: https://firefox-source-docs.mozilla.org/devtools/tools/inspector-panel.html

Honza

Comment 1

[Abhijeet Chawla[:ff2400t]]

Hey Nicholas, I would like to tackle this Bug As well

Comment 2

[u758952]

Description:
Please provide an explanation of the feature or change. Include a description of the user scenario in which it would be used and how the user would complete the task(s).
Screenshots and visual UI specs are welcome, but please include sufficient accompanying explanation so that blind members of the accessibility team are able to understand the feature/change.

How do we test this?
If there is an implementation to test, please provide instructions for testing it; e.g. setting preferences, other preparation, how to trigger the UI, etc.

When will this ship?
Tracking bug/issue:
Design documents (e.g. Product Requirements Document, UI spec):
Engineering lead:
Product manager:

The accessibility team has developed the Mozilla Accessibility Release Guidelines which outline what is needed to make user interfaces accessible:
https://wiki.mozilla.org/Accessibility/Guidelines
Please describe the accessibility guidelines you considered and what steps you've taken to address them:

Describe any areas of concern to which you want the accessibility team to give special attention:

Comment 3

[Hubert Boma Manilla (:bomsy)]

(In reply to abhijeetchawla[:ff2400t] from comment #1)

Hey Nicholas, I would like to tackle this Bug As well

Sure abhjijeet. Also thanks for opening the patch in Bug 1855168. Will review soon.

Comment 4

[Abhijeet Chawla[:ff2400t]]

Attachment: Bug 1855165 - Use MermaidJS to replace ASCII based Inspector Panel architecture diagram r?bomsy

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/6647e978f242
Use MermaidJS to replace ASCII based Inspector Panel architecture diagram r=devtools-reviewers,ochameau

Comment 6

[Cristian Tuns]

https://hg.mozilla.org/mozilla-central/rev/6647e978f242