contributing: drop the no-Mermaid prohibition - #26
Merged
Conversation
The Diagrams section banned Mermaid outright. In practice this was ignored — architecture.md has shipped with a Mermaid flowchart since the deployment-diagram PR, and the implementation-readiness pass had to back-convert two useful lifecycle/data-flow diagrams to ASCII solely to comply with the rule on paper. The constraint produced no benefit and forced uglier diagrams. Allow both ASCII and Mermaid; keep the ban on external images and external tooling (no PNGs, no draw.io, no Lucid).
User feedback: the prescriptive diagram-style rule has no business being in a contributing guide. Devs choose what renders the point best. Section dropped.
TaprootFreak
marked this pull request as ready for review
June 6, 2026 12:20
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The
### Diagramssection inCONTRIBUTING.mdprescribed diagram style and was repeatedly ignored in practice:architecture.mdhas shipped a Mermaidflowchart TBsince Expand README with full project documentation #2.A contributing guide is not the place to dictate diagram form. Devs pick what renders the point best.
What changes
The entire
### Diagramssubsection is removed (10 lines).The bans on external images and external tooling were de-facto carried by the project anyway (everything in
docs/is markdown + Docusaurus); no need to re-state them as diagram-style rules.Verification
Single-section removal, no code touched, no build artefacts affected.