Skip to content

Publishing this wiki

This wiki is a MkDocs Material site built from the hand-authored markdown in docs/. It uses the same theme as the other Twycis wikis. GitHub Actions builds it; Cloudflare Pages only hosts the pre-built static site.

How it fits together

docs/ + mkdocs.yml   ──►   mkdocs build --strict   ──►   site/   ──►   Cloudflare Pages

Unlike the Skills wiki, which generates its pages from SKILL.md files via a generate.py script, this wiki is authored by hand — the nav lives directly in mkdocs.yml. Edit a page, push to main, done.

Build locally

pip install -r requirements.txt
mkdocs serve                 # preview at http://127.0.0.1:8000
mkdocs build --strict        # what CI runs — fails on broken links or nav

One-time Cloudflare Pages setup

  1. Create the project (direct-upload, no Git connection — Actions uploads the build):

    npx wrangler pages project create deployment-wiki --production-branch=main

    Or in the dashboard: Workers & Pages → Create → Pages → Upload assets, name it deployment-wiki. (Use a different name only if you also set the CF_PAGES_PROJECT repo variable to match.)

  2. Create an API token: My Profile → API Tokens → Create Token, use the Cloudflare Pages → Edit template (account-scoped). Copy the token.

  3. Find your Account ID: any Workers & Pages page shows it in the right sidebar.

  4. Add the repo secrets (Settings → Secrets and variables → Actions → New repository secret):

    Secret Value
    CLOUDFLARE_API_TOKEN the token from step 2
    CLOUDFLARE_ACCOUNT_ID the account ID from step 3

    Optional: add an Actions variable CF_PAGES_PROJECT if your project name isn't deployment-wiki.

  5. Push to main (or run the wiki workflow manually via Actions → wiki → Run workflow). The site deploys to https://deployment-wiki.pages.dev. Add a custom domain in the Pages project settings if you want one, the same way as the other wikis.

Updating the wiki

Edit any page under docs/ and push to main. The workflow rebuilds and redeploys automatically — no manual publish step.