This repository contains the documentation for the Qualytics platform, built using Material for MkDocs.

This project requires the following tools:

• Python 3.13+
• MkDocs
• pre-commit
• typos
• mkdocs-print-site-plugin
• VS Code with the Run on Save extension (recommended)

To preview the documentation locally

1. Activate the virtual environment
2. Run the following command:

mkdocs serve

mkdocs serve -a localhost:8080

To enable PDF export via the print-site plugin:

1. Open the mkdocs.yml file.
2. Set the print-site plugin to enabled.
3. Run mkdocs build or mkdocs serve.

Create a Python virtual environment:

python3 -m venv <your_env_name>

Use the appropriate command based on your operating system and shell:

python -m pip install --upgrade pip

pip install -r requirements.txt

This repository uses pre-commit to automatically check for spelling errors using typos.

pip install pre-commit

pre-commit install

To run the pre-commit checks manually:

pre-commit run --all-files

If you are using Visual Studio Code, it's recommended to install the Run on Save extension.

With this extension, every time you save a file in the project, it automatically executes Typos to check for misspelled words throughout the codebase. The results will be shown in the Output panel under the Run On Save section.

To configure it, add the following snippet to your .vscode/settings.json:

{ "emeraldwalk.runonsave": { "commands": [ { "match": ".*", "cmd": "pre-commit run --all-files" } ] } }