website: Support mermaid diagram rendering
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 717
- Forks
- 1.2k
- Avg merge
- 3d 15h
- Merged PRs (30d)
- 19
Description
We start to leverage mermaid for diagrams in OM2: https://prometheus.io/docs/specs/om/open_metrics_spec_2_0/
Let's add some renderer to our website for it too.
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 by inspecting how the website renders the OM2 specification page at the linked URL and where diagram content is processed. Determine the existing website build and rendering entry points before choosing an integration approach. Done means Mermaid diagrams in the documentation render correctly in the built website.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, frontend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 48/100