Contribute

Contribute to the project¶

Below is the standard lifecycle of a documentation contribution, from identifying an issue to merging the updated content into production.

graph TD
    A[1. Auto Fetch in VSCode] --> B[2. Make edits and save]
    B --> C[3. Serve and preview locally]
    C --> D[4. Commit and push changes]
    D --> E[5. Cloudflare kicks off build process]
    E --> F[6. Live site updated]

Step-by-Step Git Operations in VS Code¶

Step 1: Auto Fetch in VSCode¶

When enabled, vscode runs git fetch automatically in the background. This keeps your local editor aware of changes made by other contributors on the remote repository before you attempt to push your own.

How to verify/enable:
Open Settings (Ctrl + ,), search for Git: Autofetch, or and set it to true (or all).

NOTE: If background Autofetch is disabled, VS Code will still automatically fetch remote updates as part of the Sync Changes process in Step 4.

Step 2: Make edits and save¶

Modify or create documentation pages, update navigation layouts, or tweak CSS elements. Save your progress: Use Ctrl + S to save your active files. Track changes: Modified files will immediately display an M (Modified) or U (Untracked) status badge in your file explorer view.

Step 3: Serve and preview locally¶

Always review your changes locally to catch formatting errors or broken links before sending them live.

Launch the Dev Server:
Press Ctrl + Shift + P to open the Command Palette.
Select Tasks: Run Task -> Serve docs.
Live Reloading: If the server is already running, the environment auto-refreshes your browser page every time you save.
Validation: Open the local address (usually http://localhost:8000 or http://127.0.0.1:8000) and watch the integrated terminal for compilation syntax errors.

Step 4: Commit and push cchanges¶

Once your edits look correct in the local preview, bundle your work and push it to the main Github repository.

Commit Locally: Open the Source Control view (Ctrl + Shift + G). Type a clear, concise description of your changes in the message box, and click Commit. This saves your changes into your local Git timeline.
Push to Github: Click the Sync Changes button that appears. This runs a combined fetch, pull, and push sequence to upload your local commits directly to the remote repository.

Step 5: CloudFlare kicks off build process¶

Cloudflare’s CI/CD pipeline automatically detects your new commit and provisions an isolated build environment to compile the documentation framework into a fast, static deployment asset.

The system runs the following installation and generation pipeline:

pip install properdocs==1.6.7 && pip install --no-deps mkdocs-material && pip install -r requirements.txt && properdocs build

* Monitoring: You can track real-time compilation logs inside the Cloudflare Pages dashboard project console to verify the build completes successfully.

Step 6: Live Site Updated¶

Upon a successful build layout verification, Cloudflare swaps deployment routes at the edge network instantly, taking your updates live globally within seconds.

TIP: Cloudflare updates assets dynamically, but your web browser may hold onto an aggressive local cache of style sheets or assets. If the live site appears outdated or broken, force a hard refresh: * Windows / Linux: Press Ctrl + F5 or Ctrl + Shift + R * macOS: Press Cmd + Shift + R