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

[Copilot]

Addresses #614 - enhance mermaid diagrams in the BIDS Validator 2.0 blog post with clickable links and visual styling to clarify what each box represents.

Changes

Enhanced all 6 mermaid diagrams in docs/blog/posts/bids-validator-2.0.md:

• Shapes for visual distinction:

  • docs - collections (schema source, regex patterns)
  • doc - single documents (specification, schema.json)
  • proc / subproc - tools and runtimes (bidsschematools, Node.js, deno, python)
  • rect - web interfaces

• Clickable links to:

  • GitHub source (src/schema/, tools/schemacode/)
  • Documentation sites (bids-specification.readthedocs.io)
  • Web validators (bids-validator, legacy-validator)
  • Python validator repo

Example styling added to end of each diagram:

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 }
schema.json@{ label: "<a href='https://bids-specification.readthedocs.io/en/v1.9.0/schema.json'>schema.json</a>", shape: doc }

Version references follow the historical timeline: v1.9.0 for v1.14.x era diagrams, v1.10.0 for v2.0 diagram.

Original prompt

---

This section details on the original issue you should resolve

<issue_title>Extend mermaid figure(s) for validator?</issue_title>
<issue_description>While going through the great visualizations @effigies cooked for us in https://bids-website.readthedocs.io/en/latest/blog/2024/11/13/bids-validator-2.html#v1146 I was asked specific questions of clarification on what any particular box corresponds to... hence we decided to add some styling and references. So instead of

graph LR;
    subgraph bids-specification;
        markdown ---> specification
        schema --> bidsschematools --> specification & schema.json
    end
    subgraph "bids-validator @ v1.14.6"; 
        regex["filename patterns"] --> Node.js
        regex["filename patterns"] --> python
        Node.js --> web
        deno
    end

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

Loading

it could look like

graph LR;
    subgraph bids-specification;
        markdown ---> specification
        schema --> bidsschematools --> specification & schema.json
    end
    subgraph "bids-validator @ v1.14.6";
        regex["filename patterns"] --> Node.js
        regex["filename patterns"] --> python
        Node.js --> web
        deno
    end

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

    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: procs}
    schema.json@{label: "<a href="https://bids-specification.readthedocs.io/en/v1.9.0/schema.json">schema.json</a>", shape: doc}

Loading

simply by adding "styling" to the nodes via

     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: procs}
    schema.json@{label: "<a href="https://bids-specification.readthedocs.io/en/v1.9.0/schema.json">schema.json</a>", shape: doc}

at the end (hence easy to reuse across figures)... v1.9.0 was chosen as bids version at time of release of that version of bids-validator.

Do you think it is worthwhile and whether anything else to tune there up.</issue_description>

<agent_instructions>original post and enhance mermaid plots with HTML links to make them more interactive. You can also pick up target links from b.com//pull/626 where applicable</agent_instructions>

Comments on the Issue (you are @copilot in this section)

@effigies Yeah, I'm fine with improving the figures. @yarikoptic Let's see to what we arrive in #626 and then just adopt the style/listing for consistent appearance but without "extending" really to grow into a monster of the #626 ;) @christinerogers any chance some is already working with mermaid charts and can get this done before the end of the year?

cc @effigies @julia-pfarr
(maybe also cc BEP process wg ? @ericearl )</comment_new>

• Fixes Extend mermaid figure(s) for validator? #625

---

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

---

📚 Documentation preview 📚: https://bids-website--747.org.readthedocs.build/en/747/

[effigies]

Sure?

[yarikoptic]

looks good to me and ppl could immediately jump to those resources

[yarikoptic]

Sure?

much better than

;-)

[yarikoptic]

ok, as no objections, I will just merge and take the blame if someone opposes