alphagov / alphagov/tech-docs-gem
[Enhancement]: Add mermaid for diagrams
Nobody has claimed this yet.
- #184 by @chrisfarms — closed without merging
- Dominant language
- Ruby
- Stars
- 16
- Forks
- 47
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 14
Description
What should change?
There is a suggestion to add in mermaid support in PR #184
This makes sense as mermaid is a well known, well supported markdown tool for generating diagrams. They are customisable, and have some configuration available for accessibility.
User need
People are already using it, but they are manually writing html into the markdown rather than using a pure markdown solution.
Proposed solution
Run a couple of experiments with
- the mermaid gem
- -mermaid npm package
- just having mermaid natively available
See how they work and which is easiest for non-technical people to use
Contributor guide
No contributing guide indexed for this repository
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 by reviewing PR #184 and the issue’s proposed Mermaid approaches. Experiment with the mermaid gem, the mermaid npm package, and native Mermaid availability, then compare accessibility, customisation, and ease of use for non-technical people. Done means documenting the comparison and identifying the preferred approach.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, ruby
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100