How to Contribute¶
-
Clone the Repository
git clone https://github.com/zubzet/framework.git
-
Start a Live Preview: Use the following Docker command to start a live preview of the documentation on port 8000:
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
-
Make Changes: Edit or add files under the /docs directory. Any changes will be automatically reflected in the live preview.
-
Submit a Pull Request: Once you’ve made your changes, push them to your fork and create a pull request to contribute your improvements.
Thank you for helping improve the ZubZet framework!