Skip to content

fix README screenshot paths to match auto-generated locations#830

Merged
PythonFZ merged 2 commits intomainfrom
fix/readme-screenshot-paths
Jan 7, 2026
Merged

fix README screenshot paths to match auto-generated locations#830
PythonFZ merged 2 commits intomainfrom
fix/readme-screenshot-paths

Conversation

@PythonFZ
Copy link
Copy Markdown
Member

@PythonFZ PythonFZ commented Jan 7, 2026

Update image paths to point to docs/source/_static/screenshots/ where
test_screenshots.py generates them, and fix filenames to match test names.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.5 noreply@anthropic.com

Summary by CodeRabbit

  • Documentation
    • Updated README image references and refreshed screenshots across Overview, API, Geometries, and Analysis.
    • Added new 1D and 2D analysis visuals with light/dark mode variants.
    • Revised deployment wording and quick-links to clarify Docker deployment options (Standalone, Production) and adjusted related wording for consistency.

✏️ Tip: You can customize this high-level summary in your review settings.

Update image paths to point to docs/source/_static/screenshots/ where
test_screenshots.py generates them, and fix filenames to match test names.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jan 7, 2026

📝 Walkthrough

Walkthrough

README image references were updated to point to docs/source/_static/screenshots/, dark/light mode variants were added or relocated across Overview, Python API connection, Geometries, and Analysis sections, and new 2D analysis screenshots were introduced.

Changes

Cohort / File(s) Summary
Documentation file
README.md
Replaced misc/* image paths with docs/source/_static/screenshots/...; updated Deployment wording and Docker quick-links (Standalone / Production); added light/dark mode and new 1D/2D analysis screenshots
Assets (referenced)
docs/source/_static/screenshots/*
README now references centralized screenshot assets (dark/light variants and new 2D images) — asset additions/relocations implied by updated paths

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • Documentation Update #820 — Updates README and documentation screenshot/asset paths, including light/dark UI screenshots (strong overlap in changed references).

Poem

📸 I hopped through docs with nimble paws,
Swapped paths and added viewable laws,
Dark and light, 2D now gleams,
Screenshots aligned for all the teams,
A rabbit cheers — the README roars! 🐰

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and directly describes the main change: updating README screenshot paths to match the auto-generated locations in docs/source/_static/screenshots/.
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.


📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ff4a92f and 64560d9.

📒 Files selected for processing (1)
  • README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: pytest (3.13, ubuntu-latest)
  • GitHub Check: pytest (3.12, ubuntu-latest)
  • GitHub Check: pytest (3.11, ubuntu-latest)

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

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

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Jan 7, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.69%. Comparing base (0ea41d4) to head (64560d9).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #830   +/-   ##
=======================================
  Coverage   78.69%   78.69%           
=======================================
  Files         153      153           
  Lines       18579    18579           
=======================================
  Hits        14621    14621           
  Misses       3958     3958           

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

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@PythonFZ PythonFZ merged commit 8782043 into main Jan 7, 2026
6 checks passed
@PythonFZ PythonFZ deleted the fix/readme-screenshot-paths branch January 7, 2026 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants