Make use of Mermaid Diagrams

Open
#238 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Domain
documentation

Research direction

Start with the Mermaid usage guide linked in the issue, then inspect the Nabu theme and existing documentation content. Determine how Mermaid support should be added and where diagrams apply; done means the theme renders the diagrams and the relevant docs include their definitions.

Written by the indexing model from the issue text.

Description

We should update our docs to make use of Mermaid diagrams: https://mermaid.js.org/config/usage.html. Would need to add support in the Nabu theme as well as update the doc content itself to include the diagram definitions where applicable.

Dominant language
No language data
Stars
40
Forks
77
No merged PRs in 30d

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.

More from wintercms/docs

All issues in wintercms/docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.