Skip to content
Public template

About

LLM-gepflegtes Wiki-Template: Quartz + GitHub Pages + Wiki-Lint + Agent-Workflow

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Team Wiki Template

Ein von LLM-Agents gepflegtes Wiki: Quartz als Static-Site-Generator, Deployment über GitHub Pages, ein mechanischer Wiki-Lint im CI, und eine AGENTS.md, die dem Agent die Pflege vorschreibt. Basiert auf dem LLM-Wiki-Pattern von Andrej Karpathy.

Aus "Use this template" wird ein Wiki

  1. Repo aus dem Template anlegen -- Button „Use this template" oben rechts.
  2. Quartz konfigurieren in quartz.config.yaml:
    • pageTitle: Name des Wikis
    • baseUrl: immer sipgate.github.io/<repo-name> -- einfach deinen Repo-Namen einsetzen (ohne https://, ohne den github.com-Repo-Link kopieren zu müssen)
    • GitHub: Link zum Repo (z. B. https://github.com/sipgate/mein-wiki)
  3. GitHub Pages aktivieren: Repo → Settings → Pages → Source: GitHub Actions. Der Workflow deploy.yml baut bei jedem Push auf main und veröffentlicht die Site.
  4. AGENTS.md anpassen: Thema des Wikis beschreiben (erste Zeilen) und die Themenbereiche festlegen, die das Team nutzen will.
  5. Beispiel-Inhalt entfernen: wiki/beispiel/, raw/beispiel-quelle.md und die Beispiel-Einträge in wiki/index.md löschen oder umbauen.
  6. Agent anbinden: Die AGENTS.md funktioniert mit jedem coding-agent, der Repo-Anweisungen liest (opencode, Claude Code, Cursor, ...). Der Agent legt Ingest-Änderungen als Pull Requests an; das automerge-Label merged sie, sobald der Lint-Check grün ist.

Vor dem ersten Merge empfehlen

  • Branch-Protection für main: Pflichtcheck „Lint Wiki", kein Direktpush.
  • Das Label automerge im Repo anlegen.

Lokal arbeiten

npm ci
npx quartz build --serve -d wiki   # Site auf http://localhost:8080
python3 scripts/lint-wiki.py       # Wiki-Lint, 0 = sauber

Wie das Wiki funktioniert

  • raw/ nimmt Quelldokumente auf (Transkripte, Notizen, Diagramm-Exporte) -- unveränderlich, nur lesen.
  • Der Agent destilliert Quellen in thematische Seiten unter wiki/, verlinkt sie untereinander und hält wiki/index.md und wiki/log.md aktuell.
  • Alles Weitere -- Strukturprinzip, Zitierregeln, PR-Betrieb -- steht in der AGENTS.md.

About

LLM-gepflegtes Wiki-Template: Quartz + GitHub Pages + Wiki-Lint + Agent-Workflow

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages