Make use of Mermaid Diagrams
Open
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 40
- Forks
- 77
- PR merge metrics
- No merged PRs in 30d
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
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.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100