Skip to content

Extend mermaid diagrams in validator blog post with HTML links and shapes #747

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yarikoptic merged 2 commits into from
Dec 3, 2025
Merged

Extend mermaid diagrams in validator blog post with HTML links and shapes #747

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b72a549
Initial plan
Copilot Nov 24, 2025
96a66df
Extend mermaid diagrams with HTML links and shapes in bids-validator-…
Copilot Nov 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions docs/blog/posts/bids-validator-2.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,11 @@ graph LR;
end

google -. interpreted .-> regex

regex@{ shape: docs }
Node.js@{ shape: subproc }
python@{ shape: subproc }
web@{ shape: rect }
```

<caption>The original validator was an interpretation of a pure text specification.
Expand Down Expand Up @@ -243,6 +248,13 @@ graph LR;
end

specification -. interpreted .-> regex

markdown@{ shape: docs }
specification@{ label: "<a href='https://bids-specification.readthedocs.io'>specification</a>", shape: doc }
regex@{ shape: docs }
Node.js@{ shape: subproc }
python@{ shape: subproc }
web@{ shape: rect }
```

<caption>The transition to a git-managed Markdown document initially made
Expand All @@ -269,6 +281,17 @@ graph LR;

specification -. interpreted .-> regex
schema.json ---> deno

markdown@{ shape: docs }
schema@{ label: "<a href='https://github.com/bids-standard/bids-specification/tree/v1.9.0/src/schema'>src/schema/</a>", shape: docs }
bidsschematools@{ label: "<a href='https://github.com/bids-standard/bids-specification/tree/v1.9.0/tools/schemacode'>tools/schemacode/</a>", shape: proc }
specification@{ label: "<a href='https://bids-specification.readthedocs.io'>specification</a>", shape: doc }
schema.json@{ label: "<a href='https://bids-specification.readthedocs.io/en/v1.9.0/schema.json'>schema.json</a>", shape: doc }
regex@{ shape: docs }
Node.js@{ shape: subproc }
python@{ shape: subproc }
web@{ shape: rect }
deno@{ shape: subproc }
```

<caption>The BIDS schema is used as an authoritative,
Expand Down Expand Up @@ -308,6 +331,17 @@ graph LR;
specification -. interpreted .-> regex
schema.json ---> deno
bidsschematools ----> python

markdown@{ shape: docs }
schema@{ label: "<a href='https://github.com/bids-standard/bids-specification/tree/v1.9.0/src/schema'>src/schema/</a>", shape: docs }
bidsschematools@{ label: "<a href='https://github.com/bids-standard/bids-specification/tree/v1.9.0/tools/schemacode'>tools/schemacode/</a>", shape: proc }
specification@{ label: "<a href='https://bids-specification.readthedocs.io'>specification</a>", shape: doc }
schema.json@{ label: "<a href='https://bids-specification.readthedocs.io/en/v1.9.0/schema.json'>schema.json</a>", shape: doc }
regex@{ shape: docs }
Node.js@{ shape: subproc }
python@{ shape: subproc }
web@{ shape: rect }
deno@{ shape: subproc }
```

<caption>
Expand Down Expand Up @@ -343,6 +377,17 @@ graph LR;
specification -. interpreted .-> regex
schema.json ---> deno
bidsschematools ----> python

markdown@{ shape: docs }
schema@{ label: "<a href='https://github.com/bids-standard/bids-specification/tree/v1.9.0/src/schema'>src/schema/</a>", shape: docs }
bidsschematools@{ label: "<a href='https://github.com/bids-standard/bids-specification/tree/v1.9.0/tools/schemacode'>tools/schemacode/</a>", shape: proc }
specification@{ label: "<a href='https://bids-specification.readthedocs.io'>specification</a>", shape: doc }
schema.json@{ label: "<a href='https://bids-specification.readthedocs.io/en/v1.9.0/schema.json'>schema.json</a>", shape: doc }
regex@{ shape: docs }
Node.js@{ shape: subproc }
python@{ label: "<a href='https://github.com/bids-standard/python-validator'>python</a>", shape: subproc }
deno@{ shape: subproc }
web@{ label: "<a href='https://bids-standard.github.io/bids-validator/'>web</a>", shape: rect }
```

<caption>The Python validator was moved into its own repository.
Expand Down Expand Up @@ -385,6 +430,18 @@ graph LR;
specification -. interpreted .-> regex
schema.json ---> deno
bidsschematools ----> python

markdown@{ shape: docs }
schema@{ label: "<a href='https://github.com/bids-standard/bids-specification/tree/v1.10.0/src/schema'>src/schema/</a>", shape: docs }
bidsschematools@{ label: "<a href='https://github.com/bids-standard/bids-specification/tree/v1.10.0/tools/schemacode'>tools/schemacode/</a>", shape: proc }
specification@{ label: "<a href='https://bids-specification.readthedocs.io'>specification</a>", shape: doc }
schema.json@{ label: "<a href='https://bids-specification.readthedocs.io/en/v1.10.0/schema.json'>schema.json</a>", shape: doc }
regex@{ shape: docs }
Node.js@{ shape: subproc }
python@{ label: "<a href='https://github.com/bids-standard/python-validator'>python</a>", shape: subproc }
deno@{ shape: subproc }
web@{ label: "<a href='https://bids-standard.github.io/bids-validator/'>web</a>", shape: rect }
web1@{ label: "<a href='https://bids-standard.github.io/legacy-validator/'>web</a>", shape: rect }
```

<caption>In version 2.0, the Deno validator removed the Node.js
Expand Down
Loading