hololinked docs

Documentation in material mkdocs for hololinked.

To build the documentation, while setting up a local development environment with uv (pip install uv), run:

uv venv
source .venv/bin/activate # or venv\Scripts\activate on Windows
uv sync --no-install-project
mkdocs build

or

mkdocs serve

This project is always looking for contributors to improve the documentation. Hop into our Discord to discuss upfront if needed and make a PR with your changes.

skaffold

To develop the documentation with skaffold within a kubernetes cluster, create a skaffold.env file specifying the docker registry. For example, if you are using Docker Hub, it should look like this:

SKAFFOLD_DEFAULT_REPO=docker.io/<your-docker-username>

Please get in touch with me by email or on discord for cluster credentials.

skaffold dev --module dev-python-docs

Or use your own cluster if you have one set up. To test if the image is building

skaffold build --module dev-python-docs

Docker

To build, tag, and publish the Docker image from your local machine, run:

set -e
docker build -t hololinked-docs .
docker tag hololinked-docs:latest ghcr.io/hololinked-dev/hololinked-docs:latest
docker push ghcr.io/hololinked-dev/hololinked-docs:latest
echo "Docker image built and pushed successfully."