Skip to main content

​
CLAUDE.md — Big Panda Doku

Diese Datei trainiert Claude Code (und andere AI-Assistenten) auf die Konventionen dieses Doku-Repos. Im Code-Repo ai_knowledger gibt es eine separate CLAUDE.md mit anderem Scope (Code-Standards) — diese hier ist nur für die Mintlify-Doku.

​
Sprache

  • Inhalte: Deutsch in Du-Form, freundlich, nicht zu formell
  • Code-Beispiele: Englisch (Kommentare, Variablen-Namen)
  • Frontmatter: englische Keys (title, description), deutsche Werte

​
Frontmatter-Pflicht

Jede *.mdx-Datei beginnt mit Frontmatter: 
---
title: "Aussagekräftiger Seitentitel"
description: "Kurzbeschreibung für SEO und Sidebar (1–2 Sätze)"
---

​
Inhalts-Standards

  • Code-Blöcke bekommen immer Sprach-Tag (bash, python, json, mdx, …)
  • Bilder brauchen Alt-Text
  • Interne Links sind relativ (/tutorials/claude-desktop, nicht volle URL)
  • Procedural Content (Tutorials) startet mit „Voraussetzungen”-Sektion
  • Code-Beispiele lokal mit npx mintlify@latest dev durchgetestet, bevor sie committed werden

​
Tonfall

  • Du-Form
  • Aktive Verben
  • Kurze Sätze
  • Beispiele vor Theorie

​
Big-Panda-Glossar (Begriffe konsistent halten)

  • Knowledge Base / Wissensdatenbank — zentrale Datenbasis pro Tenant
  • Visibility Ceiling — Sichtbarkeits-Obergrenze: public < internal < restricted < community
  • Drei-Achsen-Auth — Auth-Modell: Scope + Rolle + Visibility (siehe ADR-015)
  • Document-Types — knowledge, skill, memory, process, glossary, bootstrap, skill_index (siehe ADR-020)
  • MCP-Tools — Model Context Protocol Endpoints für KI-Clients
  • Bootstrap — pro Tenant ein Singleton-Eintrag mit Mental-Modell für KI

​
Git

  • Niemals --no-verify beim Commit (Pre-commit-Hooks haben einen Grund)
  • Commit-Messages auf Englisch, im Imperativ, kurz
  • Eine logische Änderung pro Commit

​
Lokale Vorschau

npx mintlify@latest dev
Öffnet localhost:3000 mit Live-Reload. Voraussetzung: Node.js 18+.

​
Was nicht ins Doku-Repo gehört

  • Architektur-Details, ADRs, Sprint-Logs → leben im Code-Repo ai_knowledger
  • Quellcode der Plattform
  • API-Specs werden später via GitLab-CI aus dem Code-Repo gepusht, nicht von Hand gepflegt

​
Querverweise zum Code-Repo

Wenn Architektur oder Datenmodell-Details für Doku-Leser (Pilot-Kunden, Dritt-Entwickler) relevant sind: erkläre sie hier in der nötigen Tiefe, ohne auf interne Sprint-Logs oder Code-Pfade zu verweisen.