gpac / wiki

GPAC's wiki, the entrypoint to MP4Box and GPAC documentation.
https://wiki.gpac.io
GNU Lesser General Public License v2.1
0 stars 3 forks source link

Potential Maintenance Challenges with Locked mkdocs-material Version #26

Open PierreDillard opened 2 weeks ago

PierreDillard commented 2 weeks ago

Description: The current setup locks the site to mkdocs-material version 9.5.44, implemented to prevent layout issues during automatic deployments after each commit to the master branch. While this solution is effective for now, it may lead to maintenance challenges in the future as mkdocs-material evolves.

Background:

nlsdvl commented 2 weeks ago

@PierreDillard - Locking the version is required not just for deployment, but also for any fresh local dev installation.

Indeed, the challenge comes from the modifications made to base.html.

Ways to deal with this situation include forking of mkdocs-material, or refactoring to avoid making changes to base.html.

Whenever updating the base.html file, the mkdocs-material version from which is was taken must be reflected in the README.md and in the automatic deployment workflow.