You can report any issues here
- Specify where (section number - ex. 4.2) and what the problem is - for example:
4.2 - typo in proof of theorem 4.1
- Add any relevant description if needed
- Create the issue
- git pull your fork to your machine
- Create a new branch
- Make a change
- Create a python virtual environment and use it to install mkdocs
python3 -m venv venv # create a python virtual environment
source venv/bin/activate # activate it
pip install mkdocs-material
- Start application
cd {your fork folder containing mkdocs.yml file}
mkdocs serve
- Go to your web browser and paste http://127.0.0.1:8000/
- You do not need to restart mkdocs for changes to be made, those will be refreshed automatically
You can also fix the issue yourself with a pull request
- Create a fork of the repository
- Fix the issue in your fork
- please try to prefix all your commits with
fix: (commit message)
- please try to prefix all your commits with
- Request merge to
main
branch oftruepeak78/ag1