Use Zensical - #425
Conversation
* Initial plan * Migrate from Material for MkDocs to Zensical Co-authored-by: pattacini <3738070+pattacini@users.noreply.github.com> * Update .github/workflows/gh-pages.yml * Update .github/workflows/test-pr.yml --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: pattacini <3738070+pattacini@users.noreply.github.com> Co-authored-by: Ugo Pattacini <ugo.pattacini@iit.it>
Updated installation command for Zensical in CI workflow.
Summary of ChangesHello @pattacini, 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 updates the documentation project to use Zensical, a modern static site generator, replacing the deprecated Material for MkDocs. The changes streamline the development environment setup, update local workflow instructions, and adjust theme configurations to ensure compatibility and leverage the new platform's features. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Ignored Files
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
|
There was a problem hiding this comment.
Code Review
This pull request migrates the documentation generator from mkdocs-material to its successor, Zensical. The changes update installation instructions in the Dockerfile and README.md, and adjust theme settings in mkdocs.yml to use new icons and colors. The migration seems correct and simplifies the setup. I have provided one suggestion in the README.md to ensure consistency and robustness in the installation instructions.
Material MkDocs is deprecated in favor of Zensical.
https://squidfunk.github.io/mkdocs-material/blog/2025/11/05/zensical/