docs: update page icons #1174
Merged
docs: update page icons #1174
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
added appropriate icon
…clock style: changed logo from material/script-text-outline to lucide/file-clock
added lucide/pencil-ruler
- Enhanced navigation structure in zensical.toml for better organization of self-hosting and developer guides. - Updated icons for various documentation pages to improve visual consistency and clarity. - Added specific icons to configuration and management sections in self-hosting documentation for better context. - Improved icon representation in FAQ and support sections to enhance user experience.
Contributor
Reviewer's GuideStandardizes documentation icons across the site and refines the self-hosting and developer best-practices navigation entries to use titled objects instead of bare paths, improving consistency and visual clarity in the docs UI. Flow diagram for updated Self-Hoster and Developer Best Practices navigation structureflowchart TB
subgraph SelfHoster_Guide
SHG["Self-Hoster Guide"]
SHG --> SHG_Install["Installation"]
SHG --> SHG_Config["Configuration"]
SHG --> SHG_Manage["Management"]
SHG_Install --> SHG_Install_Docker["Docker (selfhost/install/docker.md)"]
SHG_Install --> SHG_Install_BareMetal["Bare Metal (selfhost/install/baremetal.md)"]
SHG_Install --> SHG_Install_FirstRun["First Run (selfhost/install/first-run.md)"]
SHG_Config --> SHG_Config_Overview["Overview (selfhost/config/index.md)"]
SHG_Config --> SHG_Config_BotToken["Bot Token (selfhost/config/bot-token.md)"]
SHG_Config --> SHG_Config_Database["Database (selfhost/config/database.md)"]
SHG_Config --> SHG_Config_Environment["Environment (selfhost/config/environment.md)"]
SHG_Manage --> SHG_Manage_Overview["Overview (selfhost/manage/index.md)"]
SHG_Manage --> SHG_Manage_Database["Database (selfhost/manage/database.md)"]
SHG_Manage --> SHG_Manage_Docker["Docker (selfhost/manage/docker.md)"]
SHG_Manage --> SHG_Manage_Operations["Operations (selfhost/manage/operations.md)"]
end
subgraph Developer_Best_Practices
DBP["Developer Best Practices"]
DBP --> DBP_Overview["Overview (developer/best-practices/index.md)"]
DBP --> DBP_Namespace["Namespace (developer/best-practices/namespace.md)"]
DBP --> DBP_Git["Git (developer/best-practices/git.md)"]
DBP --> DBP_Branching["Branching (developer/best-practices/branch-naming.md)"]
DBP --> DBP_CI_CD["CI/CD (developer/best-practices/ci-cd.md)"]
DBP --> DBP_Async["Async (developer/best-practices/async.md)"]
DBP --> DBP_ErrorHandling["Error Handling (developer/best-practices/error-handling.md)"]
end
Docs_Home["Docs Home Navigation"] --> SelfHoster_Guide
Docs_Home --> Developer_Best_Practices
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
|
Caution Review failedThe pull request is closed. WalkthroughThis PR adds icon metadata to documentation by introducing Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Possibly related PRs
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: Organization UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (120)
✏️ Tip: You can disable this entire section by setting 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. Comment |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
![amazon-q-developer[bot]](https://avatars.githubusercontent.com/in/1220912?s=60&v=4){kind=small}
There was a problem hiding this comment.
Documentation Icon Update Review
This PR successfully updates the documentation icons across the entire project, replacing Material Design icons with Lucide icons and adding icons to pages that previously lacked them. The changes are:
✅ Consistent and systematic - All icon updates follow the same pattern and use semantically appropriate icons
✅ Well-organized - Navigation structure improvements in zensical.toml enhance the documentation organization
✅ No functional impact - Pure documentation changes that don't affect code functionality
✅ Appropriate icon choices - Icons match their content context (e.g., lucide/square-terminal for commands, lucide/database for database topics)
The 120+ file changes are all straightforward icon updates and navigation improvements. No issues found that would block merge.
You can now have the agent implement changes and create commits directly on your pull request's source branch. Simply comment with /q followed by your request in natural language to ask the agent to make changes.
Summary of ChangesHello @kzndotsh, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request primarily focuses on enhancing the documentation's aesthetic and navigational quality. It involves a comprehensive update of page icons to a new, unified set and a structural refinement of the navigation menu to make content discovery more intuitive and user-friendly. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
Contributor
📚 Documentation Preview
|
❌ 4 Tests Failed:
View the full list of 4 ❄️ flaky test(s)
To view more test analytics, go to the [Prevent Tests Dashboard](https://All Things Linux.sentry.io/prevent/tests/?preventPeriod=30d&integratedOrgName=allthingslinux&repository=tux&branch=Icon) |
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
No issues found across 120 files
Confidence score: 5/5
- Automated review surfaced no issues in the provided summaries.
- No files require special attention.
Note: This PR contains a large number of files. cubic only reviews up to 75 files per PR, so some files may not have been reviewed.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request provides a great improvement to the documentation by standardizing all page icons to the Lucide icon set. This brings a consistent and modern look and feel across the entire documentation site. The changes are applied thoroughly across all relevant markdown files. Additionally, the updates to zensical.toml improve the navigation structure by providing explicit, more descriptive labels for sidebar items, which enhances user experience. The changes are well-executed and I approve of them.
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.
Pull Request
Description
Provide a clear summary of your changes and reference any related issues. Include the motivation behind these changes and list any new dependencies if applicable.
If your PR is related to an issue, please include the issue number below:
Related Issue: Closes #
Type of Change:
Guidelines
My code follows the style guidelines of this project (formatted with Ruff)
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation if needed
My changes generate no new warnings
I have tested this change
Any dependent changes have been merged and published in downstream modules
I have added all appropriate labels to this PR
I have followed all of these guidelines.
How Has This Been Tested? (if applicable)
Please describe how you tested your code. e.g describe what commands you ran, what arguments, and any config stuff (if applicable)
Screenshots (if applicable)
Please add screenshots to help explain your changes.
Additional Information
Please add any other information that is important to this PR.
Summary by Sourcery
Standardize documentation icons and navigation labels across the docs site.
Documentation: