Contributing & Deployment

Local Development

# Install dependencies
pip install -r requirements.txt

# Serve locally with live reload
mkdocs serve

# Build without versioning (for testing)
mkdocs build --strict

Deploying a New Version

The documentation is hosted on a CWP server at saas.docs.sadeem.cloud. There is no automated CI/CD — deployments are manual.

Step 1: Build the version

# Build a new version and mark it as the latest
./scripts/build-version.sh 18.0 --latest

# Or build a non-default version (e.g., maintaining 17.0 docs)
./scripts/build-version.sh 17.0

This produces: - dist/18.0/ — the built site for version 18.0 - dist/latest/ — a copy of 18.0 (only if --latest was used) - dist/versions.json — updated version manifest

Step 2: Upload to CWP

Upload the following to the server's web root (public_html/ for saas.docs.sadeem.cloud):

Step 3: Verify

Visit: - https://saas.docs.sadeem.cloud/ → should redirect to /latest/ - https://saas.docs.sadeem.cloud/18.0/ → should load version 18.0 - The version dropdown in the header should show all available versions

Adding Changelog Entries

When releasing a new version, add an entry to docs/developer/changelog.md before building.