Include simulations.json in docs deploy

[sbryngelson]

User description

Summary

• Adds simulations.json to the CMake install list so it gets deployed to mflowcode.github.io alongside index.html
• The previous commit on master (9e216d8) extracted the inline simulation data to docs/simulations.json and updated index.html to fetch from it, but missed adding it to the CMake install — so it never reaches the deployed site

Context

This enables the group website (comp-physics.group) to fetch simulation showcase data directly from mflowcode.github.io/simulations.json, keeping both sites in sync without manual maintenance.

Test plan

• CI passes (docs build)
• After merge + docs deploy, verify https://mflowcode.github.io/simulations.json returns valid JSON
• Verify https://mflowcode.github.io/ still renders simulation cards correctly

🤖 Generated with Claude Code

---

CodeAnt-AI Description

Deploy simulations.json with the site so simulation data is served

What Changed

• The docs deployment now includes docs/simulations.json so it is published alongside index.html and 404.html
• The deployed site will serve https://mflowcode.github.io/simulations.json, allowing external sites to fetch the simulation list
• Simulation cards on the published site will receive their external data as expected after deploy

Impact

✅ simulations.json served at mflowcode.github.io
✅ External sites can fetch up-to-date simulation data
✅ Simulation gallery renders correctly after docs deploy

💡 Usage Guide

Checking Your Pull Request

Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.

Talking to CodeAnt AI

Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:

@codeant-ai ask: Your question here

This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.

Example

@codeant-ai ask: Can you suggest a safer alternative to storing this secret?

Preserve Org Learnings with CodeAnt

You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:

@codeant-ai: Your feedback here

This helps CodeAnt AI learn and adapt to your team's coding style and standards.

Example

@codeant-ai: Do not flag unused imports.

Retrigger review

Ask CodeAnt AI to review the PR again, by typing:

@codeant-ai: review

Check Your Repository Health

To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.

Summary by CodeRabbit

• Documentation
  • Added simulation examples to the distributed docs and updated the docs page to include those simulations directly.
• Chores
  • Extended the set of documentation files included in the installation package.

[codeant-ai]

CodeAnt AI is reviewing your PR.

---

Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

[Copilot]

Pull request overview

Ensures the documentation deployment includes docs/simulations.json so the landing page (and external consumers) can load the extracted simulation showcase data from the published GitHub Pages site.

Changes:

• Adds docs/simulations.json to the cmake install(FILES ...) list under MFC_DOCUMENTATION so it’s deployed alongside index.html.

[codeant-ai]

Sequence Diagram

This PR adds docs/simulations.json to the CMake install list so the docs build and deploy include the JSON file. As a result the hosted site (mflowcode.github.io) serves simulations.json which external sites can fetch to render the simulation gallery.

sequenceDiagram
    participant Dev
    participant CI_Build as "CI / Docs Build (CMake)"
    participant Deploy as "Docs Deploy (GitHub Pages)"
    participant Host as "mflowcode.github.io"
    participant External as "comp-physics.group (consumer)"

    Dev->>CI_Build: Commit CMakeLists change (install simulations.json)
    CI_Build->>Deploy: Build docs & include simulations.json in install
    Deploy->>Host: Publish docs (index.html, 404.html, simulations.json)
    External->>Host: GET /simulations.json
    Host-->>External: 200 OK (simulations.json)
    External->>External: Render simulation cards from JSON

Loading

---

Generated by CodeAnt AI

[codeant-ai]

CodeAnt AI finished reviewing your PR.

[cubic-dev-ai]

No issues found across 1 file

Confidence score: 5/5

• Automated review surfaced no issues in the provided summaries.
• No files require special attention.

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

Added docs/simulations.json to the install manifest and replaced the external fetch in docs/index.html with an inline sims data structure that is rendered on DOMContentLoaded instead of being loaded from simulations.json.

Changes

Cohort / File(s)	Summary
Build Configuration CMakeLists.txt	Added docs/simulations.json to the set of documentation files installed/deployed.
Documentation / Frontend docs/index.html	Removed runtime fetch of simulations.json; introduced an inline sims array and wrapped rendering in DOMContentLoaded to render simulations directly from the inline data.

Sequence Diagram(s)

(Skipped — changes are limited to inline data and client-side rendering in a single HTML file, not meeting the multi-component flow requirement.)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• Simplify landing page JS and fix broken scaling section #1132 — similar change to docs/index.html: switching simulation rendering from fetched/FS-backed data to inline plain objects and adjusting DOM rendering.
• Add simulation gallery entries and computer links #1160 — related modifications to simulation rendering and gallery behavior in docs/index.html that also remove or replace the external simulations.json fetch.
• Include simulations.json in docs deploy #1166 — adds docs/simulations.json to CMakeLists.txt install list, matching the manifest modification in this PR.

Poem

🐰 I hopped through files both small and spry,
A JSON friend now travels where docs lie,
From fetch to inline, a smoother run,
One tiny change — a bit of fun,
Hooray — the gallery greets the sun! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely summarizes the main change: adding simulations.json to the docs deployment.
Description check	✅ Passed	The PR description provides comprehensive context, motivation, and a test plan, though it doesn't strictly follow the repository's template structure with all required sections.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch simulations-json

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 44.06%. Comparing base (d048c4b) to head (5a8dd03).
⚠️ Report is 9 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1166      +/-   ##
==========================================
- Coverage   44.07%   44.06%   -0.01%     
==========================================
  Files          70       70              
  Lines       20431    20431              
  Branches     1974     1975       +1     
==========================================
- Hits         9004     9003       -1     
  Misses      10291    10291              
- Partials     1136     1137       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.