Cloudflare — Technical Documentation Wiki¶

Overview¶

Vitara uses Cloudflare Pages to host and serve the MkDocs-generated technical documentation site. The wiki is the single source of truth for all developer, architectural, and feature documentation for the platform.

What Is Hosted on Cloudflare¶

The documentation site is built from the docs/ directory using MkDocs with the Material theme. Cloudflare Pages serves the static output (site/) globally via Cloudflare's CDN.

What	Detail
Site generator	MkDocs (Material theme)
Source	`docs/technical documents/` (Markdown files)
Config	`mkdocs.yml` at the repository root
Build output	`site/` directory (generated by `mkdocs build`)
Hosting	Cloudflare Pages

Why Cloudflare Pages¶

Zero-config CDN — documentation is served globally with low latency from Cloudflare's edge network.
Free static hosting — no server or container maintenance required for documentation.
Automatic deployments — Cloudflare Pages can be connected to the GitHub repository and rebuild the site on every push to the main branch.
Access control — Cloudflare Access (Zero Trust) can gate the wiki behind an identity provider, restricting it to team members only without any application-level auth code.
Custom domain — the wiki can be served under a subdomain (e.g., docs.vitara.elroitec.com) managed through Cloudflare DNS.

Build & Deploy Flow¶

Developer pushes to main branch
        │
        ▼
GitHub Actions (or Cloudflare Pages CI)
        │
        ├─ pip install mkdocs-material
        ├─ mkdocs build  →  outputs to site/
        │
        ▼
Cloudflare Pages
        │
        └─ Deploys site/ to CDN edge nodes globally

Manual Build (Local)¶

# Install dependencies
pip install mkdocs-material

# Preview locally (live reload)
mkdocs serve

# Build static output
mkdocs build

The local preview runs at http://127.0.0.1:8000.

Documentation Structure¶

The nav is defined in mkdocs.yml. All source files live in docs/technical documents/.

Section	Files
Home	`Home.md`
Authentication	`Authentication.md`, `Biometric-Authentication.md`
Clinical Features	`BGL-Assessment.md`, `Blood-Pressure-Monitoring.md`, `Incidents-Diabetes.md`, `Incidents-Blood-Pressure.md`, `Meal-Entry.md`
Core Features	`Dashboard.md`, `Profile.md`, `Care-Recipients.md`, `Notifications.md`, `Supplies.md`, `Offline-Queue.md`
Admin	`Management.md`, `Classification-Management.md`, `Cycles-Terms.md`, `Feature-Bug-Reports.md`, `App-Configuration.md`
Infrastructure	`Push-Notifications.md`, `Export-Reports.md`, `Google-Drive-Integration.md`, `Cloudflare-Wiki.md`
Business	`Business-Overview.md`

Adding or Updating Documentation¶

Create or edit a .md file in docs/technical documents/.
If it is a new file, register it in the nav: section of mkdocs.yml.
Push to the main branch — Cloudflare Pages picks up the change and rebuilds automatically.

Markdown Conventions Used in This Wiki¶

Feature	Syntax
Code blocks	Fenced ``` blocks with language tag
Tables	Standard GFM pipe tables
Headings	`##` for sections, `###` for subsections
Inline code	Backtick ` for class names, endpoints, field names
Diagrams	ASCII flow diagrams inside fenced code blocks

Cloudflare Access (Optional Security Layer)¶

If the wiki needs to be restricted to team members only, Cloudflare Access (part of Cloudflare Zero Trust) can be enabled on the Pages deployment:

Gate the site behind a Google Workspace or GitHub SSO login.
No changes to the MkDocs source or Angular app are required.
Configured entirely in the Cloudflare dashboard under Zero Trust → Access → Applications.

File	Purpose
`mkdocs.yml`	MkDocs configuration — theme, nav, plugins
`requirements.txt`	Python dependencies for the docs build (MkDocs, Material theme)
`docs/technical documents/`	All wiki Markdown source files