Skip to content

Use Zensical - #425

Merged
pattacini merged 11 commits into
mesh-iit:masterfrom
pattacini:master
Dec 20, 2025
Merged

Use Zensical#425
pattacini merged 11 commits into
mesh-iit:masterfrom
pattacini:master

Conversation

@pattacini

Copy link
Copy Markdown
Member

Material MkDocs is deprecated in favor of Zensical.
https://squidfunk.github.io/mkdocs-material/blog/2025/11/05/zensical/

Copilot AI and others added 11 commits December 20, 2025 17:00
* 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.
@pattacini pattacini self-assigned this Dec 20, 2025
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @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

  • Migration to Zensical: The documentation build system has been migrated from the deprecated Material for MkDocs to Zensical, aligning with the latest recommendations for documentation generation.
  • Dockerfile Update: The development container's Dockerfile now installs zensical directly via pip, removing the previous mkdocs and associated dependency fetching steps.
  • Documentation Updates: The README.md has been updated to reflect the new installation and serving commands for zensical in both local and conda environments, ensuring users follow the correct setup procedures.
  • Theme Configuration Adjustment: The mkdocs.yml configuration file has been updated to use lucide icons for theme toggles and adjusted the dark mode accent color to orange, likely to better integrate with the Zensical theme.

🧠 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
  • Ignored by pattern: .github/workflows/** (2)
    • .github/workflows/gh-pages.yml
    • .github/workflows/test-pr.yml
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@pattacini
pattacini merged commit 990c09f into mesh-iit:master Dec 20, 2025
1 check passed

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants