Docs style update - #984
Open
hellt wants to merge 11 commits into
Open
Conversation
- Introduced a new SVG logo for dark backgrounds: `gnmic-wordmark-for-dark-bg.svg`. - Updated the existing wordmark SVG file to ensure compatibility with the new design. - Created a new CSS file `header.css` to manage the display of the wordmark in the header. - Modified `mkdocs.yml` to set the new logo and include the custom CSS. - Added a new logo partial in the overrides to handle light and dark mode logos.
- Added tags to event processor documentation files to categorize them under "Event processor". - Enhanced various input and output documentation files with relevant tags for better organization. - Included tags in target discovery documentation to facilitate easier navigation and filtering. - Updated general documentation files with appropriate tags to enhance user experience and search functionality.
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.
Summary
Switching from the 5 years old docs engine to Zensical. New home page layout, new build system.
to try it out:
The documentation site now has a redesigned, responsive home page with clearer product messaging, guided quick-start examples, telemetry workflow visuals, and direct paths to key guides and deployment examples. The header and branding were refreshed with theme-aware logos, a custom light/dark-mode switch, and a dedicated favicon.
Documentation discovery was improved by adding a consistent tag taxonomy across commands, guides, integrations, processors, and deployment examples. Search now supports tag-based filtering and highlighted results.
Documentation development and publishing now use a locked Zensical/uv environment with
maketargets for serving, building, updating, and deploying the site. CI uses the same workflow, providing a consistent strict build locally and in GitHub Actions.Finally, tool and container versions are centralized in
versions.envand consumed by local wrappers, CI, Docker builds, release tooling, and integration tests. This reduces version drift and gives maintainers a single place to manage supported tool versions.History
e1a86174— Initializes the documentation refresh: adopts a locked Zensical/uv toolchain, adds reproducible local build/serve/deploy commands and CI publishing, modernizes the base theme/navigation, and fixes several documentation links. This gives contributors and CI one consistent, strict documentation build path.ffa33d68— Adds dedicated light- and dark-background gNMIc wordmark assets plus header overrides that select the appropriate logo. This keeps the brand legible and visually consistent in either color scheme.443d3b9d— Replaces the basic home page with a responsive product landing page: hero, capability and telemetry sections, quick-start examples, clearer calls to action, dedicated styling, and fragment-aware tab behavior. This makes the documentation entry point more useful for both new users and returning users.eb9eee9c— Adds a shared taxonomy of page tags across commands, integrations, deployments, processors, and guides, and configures tag icons and highlighted search results. This improves search filtering, related-content discovery, and documentation organization.dd7ebb9a— Centralizes development, CI, release, Docker, and test-image versions inversions.env; adds wrappers and validation to consume those versions consistently. This reduces version drift and makes builds, tests, releases, and documentation tooling reproducible.adae6d35— Adds a gNMIc-specific SVG favicon and configures the documentation site to use it. This improves branding in browser tabs while preserving contrast in dark color schemes.43ce26e0— Replaces the default palette control with an accessible, animated header theme switch that preserves the documentation theme’s native keyboard controls and stored preference behavior. This provides a clearer light/dark-mode experience while respecting reduced-motion settings.72f40c14— Refines the home-page hero glow’s position, size, and mobile behavior so it frames the logo rather than bleeding into navigation. This improves visual focus and polish across screen sizes.