Skip to content
Sven Rosema edited this page Jun 1, 2026 · 5 revisions

Wiki source

This directory holds the Markdown sources for the project's GitHub Wiki. They live in the main repo (rather than the wiki's own git repo) so they're versioned, reviewed, and PR-able alongside the code.

Conventions

  • One Markdown file per wiki page. Filenames become URL slugs.
  • GitHub wikis are flat — no subdirectories. Use prefix-style names instead (Google-Calendar.md, Kiosk-Windows-11-Mele-4C.md).
  • _Sidebar.md and _Footer.md render on every wiki page.
  • Home.md is the landing page.
  • Internal links must be extensionless: [Quick start](Quick-start), NOT (Quick-start.md). On a GitHub wiki the .md suffix makes GitHub serve the raw file (raw.githubusercontent.com/wiki/...) instead of the rendered page, so .md links are broken navigation. (In-repo these extensionless links don't resolve — the rendered wiki is the canonical view.)
  • Images live in docs/wiki/images/ and are copied across when publishing.

Publishing

GitHub creates a sibling git repo for the wiki at https://github.com/<owner>/<repo>.wiki.git. To publish:

# One-time clone of the wiki repo
git clone https://github.com/svenger87/kinboard.wiki.git /tmp/wiki

# Sync from this directory
cp docs/wiki/*.md /tmp/wiki/
mkdir -p /tmp/wiki/images
cp -r docs/wiki/images/* /tmp/wiki/images/ 2>/dev/null || true

# Commit + push
cd /tmp/wiki
git add -A
git commit -m "Sync from main repo"
git push

A small docs/wiki/sync.sh script can be added later to make this a one-liner.

Page index

Page Status
Home Authored
Quick-start Authored
Architecture Authored
Self-hosting Authored
Onboarding Authored
Security-and-Threat-Model Authored
Database-Schema Authored
Google-Calendar Authored — TODO screenshots
Home-Assistant Authored — TODO screenshots
Immich Authored — TODO screenshots
Bring Authored — TODO screenshots
OpenWeatherMap Authored
Cameras Authored
Reference-Build Authored — BOM, frame, photos, vendor links
Kiosk-Windows-11-Mele-4C Authored from production capture
Kiosk-Linux-Guidance Authored as guidance
Presence-Sensor Authored
Notifications Authored — PWA install + iOS quirks
Themes Authored
Troubleshooting Authored — grow as bugs surface
Plugin-Authoring Stub — v1.1 workstream
Dashboard Authored — TODO screenshots
Calendar Authored — two-way Google sync — TODO screenshots
Shopping Authored — built-in offline + optional Bring — TODO screenshots
Recipes Authored — Chefkoch + schema.org URL import — TODO screenshots
Tasks Authored — TODO screenshots
Notes Authored — TODO screenshots
Birthdays Authored — TODO screenshots
Schedule Authored — TODO screenshots
Smart-Home Authored — TODO screenshots
Screensaver Authored — TODO screenshots
Family-Members Authored — TODO screenshots
Devices Authored — TODO screenshots
Screenshots-needed Master list of every TODO screenshot

Clone this wiki locally