Integrate PR #400: Documentation Updates by @angrycuban13 #401
Conversation
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
…multiple_configurations.md`
…ion\module_installation.md` and `pages\initial_configuration\initial_configuration.md`
- use `@media (prefers-color-scheme)` to apply different styles for light and dark modes. - adjusts background and text colors for better readability in both light and dark modes.
…ganization - added support for external navigation structure with `.nav.yml` - added dynamic dark/light mode support using `palette` with `prefers-color-scheme`. - introduced new plugins: - `awesome-nav` for enhanced navigation customization. - `glightbox` for advanced image handling with zoom and captions. - `open-in-new-tab` to ensure external links open in a new tab. - expanded Markdown extensions: - Added `pymdownx.highlight` with `auto_title` for better code block titles. - improved organization: - grouped sections logically (theme, plugins, extensions, extras). - alphabetized plugins and extensions for better readability. - removed deprecated configurations like `google_analytics`.
- renamed `multiple_configurations.md` to `multi_use_configurations.md`
- split `initial_configuration.md` into individual files for a better configuration flow
- add screenshots for documentation - all files have been compressed using compresspng.com
- updated documentation links for configuration and installation
- changed directory name from `getting_started` to `configuration`
- added `user_management.md` - added `license_management.md` - added `custom_schemas_management.md`
- `README.md` now closely mirrors `index.md`
scrthq
approved these changes
May 16, 2025
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.
This pull request incorporates the significant documentation enhancements originally submitted in #400 by @angrycuban13.
This new PR was created to ensure all repository CI checks (Build Module, Test Module) run correctly against the proposed changes, as there were difficulties triggering these checks on the original PR from the contributor's fork.
Key changes from original PR #400 include:
mkdocs-awesome-pages(viaawesome-navinmkdocs.yml) for better navigation control.pymdownx.highlightfor enhanced code block styling.mkdocs-glightboxfor lightbox image viewing.mkdocs-open-in-new-tabto open external links in new tabs.mkdocs-social-pluginfor social media cards.Note on the
socialplugin:During local testing on a Windows environment, issues were encountered with the
socialplugin due toCairoSVGdependencies (no library called "cairo-2" was found). The plugin was temporarily disabled to allow local serving of the documentation and then re-enabled. While the documentation built successfully with the plugin re-enabled, its full functionality (especially image generation for social cards) should be monitored closely on the live site after this merge. Further investigation or platform-specific instructions forCairoSVGmight be needed if issues arise.All credit for the documentation improvements goes to @angrycuban13.
Resolves #400