Incorporation of new logo for OpenMS docs #254
Conversation
WalkthroughThe Sphinx documentation configuration file has been updated. The modifications include updating the favicon's file path, removing the logo variable, and introducing new logo options for light and dark themes. These changes reflect an update in the visual branding elements used in the documentation. Changes
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🔇 Additional comments (4)
✨ Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (5)
_static/FinalLogo_Nov2024_Versions-01.svgis excluded by!**/*.svg_static/FinalLogo_Nov2024_Versions-02.svgis excluded by!**/*.svgassets/logo/OpenMS.svgis excluded by!**/*.svgassets/logo/OpenMS_transparent_background.pngis excluded by!**/*.pngassets/logo/favicon.pngis excluded by!**/*.png
📒 Files selected for processing (1)
docs/conf.py(1 hunks)
🔇 Additional comments (2)
docs/conf.py (2)
105-105: Favicon path updated correctly.The favicon path has been updated to point to the new logo file, which aligns with the PR objectives.
114-115:Details
✅ Verification successful
Light and dark mode logos properly configured.
The theme configuration now includes specific logos for light and dark modes, which is a good practice for improved user experience.
However, the file paths for the logos may need verification - are these SVG files located in the
_staticdirectory? The naming convention withNov2024might also be confusing since we're in March 2025.
🏁 Script executed:
#!/bin/bash # Check if the logo files exist in the expected locations echo "Checking for logo files in _static directory:" fd "FinalLogo_Nov2024_Versions-.*\.svg" _static echo "Checking for logo files in static directory (alternate location):" fd "FinalLogo_Nov2024_Versions-.*\.svg" ../_static echo "Checking for logo files in assets directory:" fd "FinalLogo_Nov2024_Versions-.*\.svg" ../assets/logoLength of output: 784
Verified Light & Dark Logos Configuration
The logos are correctly set up: both
FinalLogo_Nov2024_Versions-01.svgandFinalLogo_Nov2024_Versions-02.svg
were found in the_staticdirectory as expected. One minor note: while the file paths are accurate, theNov2024naming may cause confusion given the current date (March 2025). It might be worth considering a naming update for clarity if future maintenance is a concern.
docs/conf.py
Outdated
| html_favicon = '../assets/logo/OpenMS_transparent_background.png' | ||
| html_logo = '../assets/logo/OpenMS_transparent_background.png' | ||
| html_favicon = '../assets/logo/favicon.png' | ||
| html_static_path = ["_static"] |
There was a problem hiding this comment.
Potential redundancy with html_static_path definition.
There appears to be a redundancy with the html_static_path configuration. You've defined it here as ["_static"], but it's defined again on line 129 as ['../_static']. The second definition would override this one, potentially causing confusion.
Consider removing this line or reconciling the two definitions to avoid unexpected behavior:
-html_static_path = ["_static"]📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| html_static_path = ["_static"] |
|
Looks reasonable. For the installation picture please go for the Long-term solution first. |
2 participants
Describe the change
This PR updates the OpenMS documentation with the following changes:
FinalLogo_Nov2024_Versions-01.svgfor light mode.FinalLogo_Nov2024_Versions-02.svgfor dark mode.favicon.png, which follows the same design theme as the new logoFinalLogo_Nov2024_Versions-01.svg.conf.pyto dynamically load the correct logo based on the theme.Proposed further changes
The documentation includes MacOS installation guide images that still display the old OpenMS logos. To maintain consistency, I propose two potential solutions:
OpenMS/OpenMSrepository to generate installation assets with the new branding.Current MacOS Installation Image:
Proposed Updated Image:
If these proposed changes align with OpenMS's goals, I will:
OpenMS/OpenMSto update the installation assets for future releases.Summary by CodeRabbit