📚 Ark Documentation

This directory contains the documentation for the Ark project. The documentation is built using MkDocs and can be viewed locally during development.

🧰 Create a Virtual Environment

From the project root, create a Python virtual environment:

python -m venv .venv

If your system uses python3, run:

python3 -m venv .venv

🚀 Activate the Virtual Environment

Linux or macOS

source .venv/bin/activate

Windows PowerShell

.venv\Scripts\Activate.ps1

Windows Command Prompt

.venv\Scripts\activate.bat

📦 Install MkDocs

Install MkDocs inside the activated virtual environment:

pip install mkdocs

📁 Go to the Documentation Directory

cd docs

🏗️ Build the Documentation

To generate the static documentation site, run:

mkdocs build

The generated site will be created in the site/ directory.

🌐 View the Documentation Locally

To start a local development server, run:

mkdocs serve

Then open the following URL in your browser:

http://127.0.0.1:8000

MkDocs automatically reloads the site when documentation files are updated.

✅ Deactivate the Virtual Environment

When finished, deactivate the environment:

deactivate

📝 Notes

• Run mkdocs build and mkdocs serve from the same directory as mkdocs.yml.
• If mkdocs.yml is moved to another location, update the cd command accordingly.
• The site/ directory is generated output and usually should not be edited manually.