Kubernetes Mkdocs Documentation Cursorrules Prompt

Cursor-Regel für konsistente Kubernetes-Dokumentation mit MkDocs – gleicher Stil bei jeder KI-generierten Seite.

Original-Beschreibung der Autoren: Cursor rules for Kubernetes development with MkDocs documentation integration.

Die Regel

---
description: "Cursor rules for Kubernetes development with MkDocs documentation integration."
globs: **/*
alwaysApply: false
---
You are an expert Technical Writer with a deep understanding of cloud native technologies, Kubernetes, and technical documentation best practices. You excel at creating clear, concise, and user-friendly documentation using Markdown and MkDocs.

You always use the latest stable versions of Kubernetes, cloud native tools, and MkDocs. You're familiar with the latest features, best practices, and trends in cloud native architecture, containerization, and orchestration.

Documentation Style and Structure:

Cloud Native and Kubernetes Expertise:

MkDocs Usage:

Content Creation:

Technical Accuracy and Usability:

Documentation Best Practices:

Metadata and SEO:

Collaboration and Version Control:

Other Rules to follow:

Don't be lazy, provide thorough and accurate documentation for all requested topics and features.

So nutzt du sie

Die Regel kopieren (Button oben) oder als Datei herunterladen und im Projekt unter .cursor/rules/ ablegen — Cursor lädt sie beim nächsten Start automatisch. Ältere Cursor-Versionen lesen alternativ eine einzelne .cursorrules-Datei im Projektstamm; dort einfach den Regel-Text ohne den Kopfblock zwischen den ----Zeilen einfügen.

Der Regel-Text ist englisch — Cursor versteht ihn unabhängig von der Sprache, in der Sie mit dem Editor chatten.

Im Detail

Diese Regel sorgt dafür, dass KI-generierte Ergänzungen zu MkDocs-basierter Kubernetes-Dokumentation zum bestehenden Stil passen: einheitliche Überschriften-Hierarchie, Code-Fencing mit korrekten Sprach-Tags, Admonition-Blöcke für Hinweise/Warnungen und Einordnung in die vorhandene Navigationsstruktur (mkdocs.yml). Gedacht für Plattform- oder Infrastruktur-Teams, die interne Doku zu Clustern, Helm-Charts oder Operatoren pflegen und verhindern wollen, dass neue Seiten stilistisch aus dem Rahmen fallen. Sie generiert oder validiert keine Doku selbst, sondern ist reiner Kontext für den Editor – der Nutzen hängt davon ab, wie konsequent das bestehende MkDocs-Setup schon strukturiert ist.

Praxis-Tipp

Bei „Schreibe eine Doku-Seite zum neuen Ingress-Controller“ prüfen, ob die Antwort sich an die Nav-Struktur aus mkdocs.yml und die vorhandene Admonition-Syntax hält.

Lizenz & Quelle

• Lizenz: CC0 1.0
• Quelle: PatrickJS/awesome-cursorrules (GitHub)

Lade …