Kubernetes Mkdocs Documentation Cursorrules Prompt

Cursor-Regel für konsistente Kubernetes-Doku mit MkDocs — Struktur & Stil automatisch eingehalten.

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 Cursor-Regel richtet sich an Teams, die Kubernetes-Dokumentation mit MkDocs pflegen. Sie gibt dem KI-Editor Leitplanken für Struktur, Formatierung und Stil vor, etwa saubere Markdown-Syntax, sinnvolle Navigation in der mkdocs.yml und konsistente Terminologie für K8s-Konzepte (Pods, Deployments, Services). Statt bei jedem neuen Dokukapitel erneut zu erklären, wie Cursor Docs erzeugen soll, wird das Wissen einmal in der Regel hinterlegt und automatisch angewendet. Sinnvoll für DevOps- und Platform-Teams, die technische Dokumentation direkt aus dem Code-Editor heraus pflegen und Wert auf einheitliche, durchsuchbare MkDocs-Seiten legen. Ersetzt kein technisches Redaktionskonzept, spart aber wiederkehrenden Prompt-Aufwand.

Praxis-Tipp

In .cursor/rules ablegen und im Prompt z. B. “Erstelle eine neue MkDocs-Seite für das Ingress-Controller-Kapitel” verwenden — die Regel sorgt automatisch für konsistente Struktur.

Lizenz & Quelle

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

Lade …