Documentation Contribution

How do I contribute to the documentation website?

Essential to have git installed in your computer

Clone the repository

git clone https://github.com/jmuozan/ArsPostFaber-docs.git

Move to your directory

cd your_directory/ArsPostFaber-docs

Create virtual environment

python -m venv venv

Activate virtual environment

MacOS

source myvenv/bin/activate

Windows

# In cmd.exe
venv\Scripts\activate.bat
# In PowerShell
venv\Scripts\Activate.ps1

Install Material for MkDocs

pip install mkdocs-material

Check changes live while editing

mkdocs serve

Create a Branch to Work on Your Changes

git branch BRANCH-NAME
git checkout BRANCH-NAME

Work on the project editing the markdown adding your documentation. Use any IDE of your wish for it. The one I use is Visual Studio Code

Push changes

git add .
git commit -m "description of the change"
git push

Pull request

With the changes done and pushed, navigate back to this repo. You'll see that your branch is one commit ahead of main. Click Contribute and then Open a pull request.