Skip to content

SaxDocs & GitHub — FAQ

This site — docs.saxobroko.com from saxobroko/SaxDocs. See This docs site.

DOC-001 — What is SaxDocs?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. Personal documentation site at docs.saxobroko.com — homelab, finance, handover. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-002 — Where is source code?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. GitHub saxobroko/SaxDocs — public repo with private login on site. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-003 — How does deploy work?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. Push to main → GitHub Actions → Cloudflare Pages. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-004 — Site stale after edit?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. Check Actions for failed build. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-005 — Edit a page?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. Edit markdown in docs/ folder, commit, push main. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-006 — Preview locally?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. pip install -r requirements.txt && mkdocs serve or docker compose — port 8000. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-007 — Need PC on for docs?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. No — moved from old NPM-on-PC to Cloudflare Pages. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-008 — Login to edit on GitHub?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. GitHub account with repo access — Ryan — vault for credentials. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-009 — Login to read docs?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. Cloudflare Access + Authentik — Open docs. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-010 — Search docs?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. Ctrl+K / ⌘K in site search. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-011 — FAQ format?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. ??? question collapsible blocks — this section. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-012 — Add new FAQ file?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. Create under docs/FAQ/, list in docs/FAQ/.pages. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-013 — Nav order?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. Controlled by .pages files per folder. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-014 — Theme?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. Material for MkDocs — mkdocs.yml. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-015 — Page history dates?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. Git revision plugin — Melbourne time at page bottom. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-016 — View blame on GitHub?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. History icon on page or footer View history link. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-017 — Secrets in markdown?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. Never — passwords in Vaultwarden only. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-018 — Will in git?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. Yes — Personal/will.md — legal paper may also exist. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-019 — Finance numbers in git?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. Approximate only (~$31k offset) — live in bank apps. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-020 — Broken link on page?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. Fix markdown link, push — or note in todo.md. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-021 — Mermaid diagrams?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. Supported in markdown — see mkdocs.yml superfences. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-022 — Images in docs?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. assets/ or relative paths — commit to repo. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-023 — Cloudflare Pages project?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. Linked to SaxDocs repo — Cloudflare doc. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-024 — Custom domain docs?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. docs.saxobroko.com in Cloudflare Pages settings. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-025 — Rollback bad deploy?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. Revert commit on main or redeploy previous Pages build. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-026 — Fork vs main repo?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. Edit saxobroko/SaxDocs directly if you have write access. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-027 — Pull request workflow?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. Optional — Ryan may push direct to main. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-028 — requirements.txt?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. Python deps for mkdocs build — CI uses same. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-029 — docker compose for docs?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. Alternative local preview — see Server/docs.md. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-030 — Plugin minify?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. pub-minifier + minify in mkdocs.yml — don't break build removing blindly. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-031 — Privacy plugin?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. Strips some external URLs at build — intentional. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-032 — Edit URI on GitHub?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. Edit button on page uses edit_uri in mkdocs.yml. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-033 — Saxon died — keep updating docs?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. Ryan may update handover notes as facts change. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-034 — 1000+ FAQ claim?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. FAQ index goal — search by category files. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow
DOC-035 — More meta docs?

Stack context: SaxDocs · GitHub Actions · Cloudflare Pages Integrated runbooks: Auth stack — docs · docs meta

Diagnose (2 min): 1. Confirm whether the problem is LAN-only, public URL, or both — see Outage runbook. 2. Check Service matrix for which app/host owns the broken URL. 3. If a single device only, retry from a second device on the same network.

  1. Server/docs.md, Guides index. Verify: Repeat the original symptom check — it should be gone or clearly improved. Deep dive: GitHub workflow