MetaMask / MetaMask/metamask-docs

Mermaid diagrams: update styles and add pan/zoom

Open
#2,906 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
861
Forks
2.1k
Avg merge
6d 10h
Merged PRs (30d)
10

Description

Update styles of Mermaid diagrams (flow charts, sequence diagrams) used throughout the docs to match the MetaMask brand colors. Include styles for light and dark modes.

Consider implementing a pan/zoom function to make large diagrams more readable: https://r74tech.github.io/docusaurus-plugin-panzoom/

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Mermaid flow-chart and sequence-diagram usage and their existing style definitions throughout the documentation. Review the linked docusaurus-plugin-panzoom project before deciding how pan/zoom fits; done means the diagrams use MetaMask brand colors in both light and dark modes, with the pan/zoom scope resolved.

Written by the indexing model from the issue text.

Assessment

Domain
design, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.