Skip to content

SaxDocs & GitHub — FAQ

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

DOC-001 — What is SaxDocs?
  1. Personal documentation site at docs.saxobroko.com — homelab, finance, handover.
DOC-002 — Where is source code?
  1. GitHub saxobroko/SaxDocs — public repo with private login on site.
DOC-003 — How does deploy work?
  1. Push to main → GitHub Actions → Cloudflare Pages.
DOC-004 — Site stale after edit?
  1. Check Actions for failed build.
DOC-005 — Edit a page?
  1. Edit markdown in docs/ folder, commit, push main.
DOC-006 — Preview locally?
  1. pip install -r requirements.txt && mkdocs serve or docker compose — port 8000.
DOC-007 — Need PC on for docs?
  1. No — moved from old NPM-on-PC to Cloudflare Pages.
DOC-008 — Login to edit on GitHub?
  1. GitHub account with repo access — Ryan — vault for credentials.
DOC-009 — Login to read docs?
  1. Cloudflare Access + Authentik — Open docs.
DOC-010 — Search docs?
  1. Ctrl+K / ⌘K in site search.
DOC-011 — FAQ format?
  1. ??? question collapsible blocks — this section.
DOC-012 — Add new FAQ file?
  1. Create under docs/FAQ/, list in docs/FAQ/.pages.
DOC-013 — Nav order?
  1. Controlled by .pages files per folder.
DOC-014 — Theme?
  1. Material for MkDocs — mkdocs.yml.
DOC-015 — Page history dates?
  1. Git revision plugin — Melbourne time at page bottom.
DOC-016 — View blame on GitHub?
  1. History icon on page or footer View history link.
DOC-017 — Secrets in markdown?
  1. Never — passwords in Vaultwarden only.
DOC-018 — Will in git?
  1. Yes — Personal/will.md — legal paper may also exist.
DOC-019 — Finance numbers in git?
  1. Approximate only (~$31k offset) — live in bank apps.
DOC-020 — Broken link on page?
  1. Fix markdown link, push — or note in todo.md.
DOC-021 — Mermaid diagrams?
  1. Supported in markdown — see mkdocs.yml superfences.
DOC-022 — Images in docs?
  1. assets/ or relative paths — commit to repo.
DOC-023 — Cloudflare Pages project?
  1. Linked to SaxDocs repo — Cloudflare doc.
DOC-024 — Custom domain docs?
  1. docs.saxobroko.com in Cloudflare Pages settings.
DOC-025 — Rollback bad deploy?
  1. Revert commit on main or redeploy previous Pages build.
DOC-026 — Fork vs main repo?
  1. Edit saxobroko/SaxDocs directly if you have write access.
DOC-027 — Pull request workflow?
  1. Optional — Ryan may push direct to main.
DOC-028 — requirements.txt?
  1. Python deps for mkdocs build — CI uses same.
DOC-029 — docker compose for docs?
  1. Alternative local preview — see Server/docs.md.
DOC-030 — Plugin minify?
  1. pub-minifier + minify in mkdocs.yml — don't break build removing blindly.
DOC-031 — Privacy plugin?
  1. Strips some external URLs at build — intentional.
DOC-032 — Edit URI on GitHub?
  1. Edit button on page uses edit_uri in mkdocs.yml.
DOC-033 — Saxon died — keep updating docs?
  1. Ryan may update handover notes as facts change.
DOC-034 — 1000+ FAQ claim?
  1. FAQ index goal — search by category files.
DOC-035 — More meta docs?
  1. Server/docs.md, Guides index.