Repository navigation
Refresh documentation screenshots for the night theme - #1250
Merged
Merged
Conversation
Regenerate 110 GUI captures, centralize tutorial references, and retire historical interface assets. Preserve original case-study measurements as lossless crops with source provenance. Extend the existing CaptureSpec registry and popup/controller paths for menus and tutorials. Selected popup captures now overwrite existing files; dropdown captures preserve transient stacking. Application runtime code is unchanged. Validation: all captures completed on Linux/Xvfb; visual image and rendered-page review; 134 local image references resolve; 13 source crops are pixel-exact; clean Sphinx build matches baseline warning set; Ruff, Black 22.10, syntax, and whitespace checks pass.
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Fix the broken image paths and the channel mapping used by the smart-object-detection capture.
Get a fresh assessment by requesting another Copilot review.
Review effort: Lite
Findings: 2
Open (2)
What changed in this PR
Refreshes documentation screenshots to the current night theme, consolidates shared assets, and documents the repeatable capture workflow.
Changes:
- Expands GUI capture coverage and overwrite behavior.
- Updates tutorials and case studies to shared screenshots.
- Adds screenshot workflow guidance and preserved-image provenance.
| File | Summary |
|---|---|
docs/source/03_contributing/06_plugin/plugin_home.rst |
Updates plugin documentation screenshots. |
docs/source/03_contributing/04_feature_container/feature_container.rst |
Updates feature-container screenshots and references. |
docs/source/02_user_guide/06_case_studies/ilastik_segmentation.rst |
Updates case-study screenshots and image references. |
docs/source/02_user_guide/06_case_studies/acquire_mesospimbt.rst |
Updates acquisition case-study screenshots and references. |
docs/source/02_user_guide/06_case_studies/08_smart_object_detection/smart_object_detection.rst |
Updates smart-object-detection screenshots. |
docs/source/02_user_guide/06_case_studies/07_smart_tiling/smart_tiling.rst |
Updates smart-tiling screenshots. |
docs/source/02_user_guide/06_case_studies/06_human_in_the_loop/human_in_the_loop.rst |
Updates human-in-the-loop screenshots. |
docs/source/02_user_guide/05_acquiring_data/02_feature_container/features.rst |
Updates feature documentation screenshots. |
docs/source/02_user_guide/04_microscope_setup/02_multiple_cameras/multiple_cameras.rst |
Updates multicamera screenshots. |
docs/SCREENSHOTS.rst |
Documents screenshot refresh and verification workflows. |
docs/case_study_image_sources.json |
Records provenance for preserved case-study images. |
docs/capture_gui.py |
Adds refreshed capture workflows and registry entries. |
docs/AGENTS.md |
Updates screenshot maintenance guidance. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| #. Go to the :guilabel:`Channels` tab. Choose the wavelength you want to align. Set the laser's :guilabel:`Power` to ``100.0``. Change :guilabel:`Filter` to an "Empty" option. | ||
|
|
||
| .. image:: images/meso_beam_1.png | ||
| .. image:: ../../images/channel-selector.png |
| .. image:: images/ilastik_1.png | ||
| :width: 400px | ||
| :align: center | ||
| .. image:: ../../images/menu-features.png |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #1250 +/- ##
===========================================
+ Coverage 67.13% 67.15% +0.01%
===========================================
Files 210 210
Lines 31068 31068
===========================================
+ Hits 20859 20864 +5
+ Misses 10209 10204 -5
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
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.
The documentation still showed the previous GUI theme, and the capture helper silently skipped existing popup images. This refresh replaces all GUI illustrations with 110 captures of the current night theme and updates the tutorial and case-study references to shared assets.
The capture registry now covers menus, feature configuration, multicamera choices, and ilastik examples. Popup captures overwrite existing files, dropdown captures preserve window stacking, and feature screenshots use the current controller-generated controls and menus. Historical GUI/debug assets are removed. Thirteen original scientific images, plots, and CSV examples are preserved as lossless crops with source-commit provenance; they are not new experimental results. No application runtime code changes.
Validation:
git diff --checkpass.docs/SCREENSHOTS.rstdocuments the repeatable refresh and verification workflow.