Skip to main content
rule

kubernetes-mkdocs-documentation-cursorrules-prompt — Cursor rule

A Cursor rule that turns the agent into a technical writer for Kubernetes and cloud native docs built with Markdown and MkDocs.

Install into Cursor · Manually: put the files in place All methods and platforms ↓
.cursor/rules/kubernetes-mkdocs-documentation-cursorrules-prompt.mdc
Open on GitHub

What kubernetes-mkdocs-documentation-cursorrules-prompt does

Drop this rule into Cursor and the agent stops treating documentation as an afterthought. It writes as a technical writer who knows Kubernetes and cloud native, and it sticks to current stable versions of Kubernetes, cloud native tooling and MkDocs.

The file covers documentation style and structure, MkDocs usage, content creation, technical accuracy, metadata and SEO, plus collaboration and version control. One line near the end is blunt: no laziness, cover every requested topic properly.

The frontmatter sets globs: **/* and alwaysApply: false. Two consequences. The rule sees every file in the project, including source code, and it stays off until you enable it yourself. So if you install it and see no change in the agent's answers, that is expected, not broken.

What it helps with

  • write a Kubernetes service guide a newcomer can follow
  • lay out the section tree for a MkDocs documentation site
  • pull scattered notes into one Markdown style
  • catch outdated Kubernetes and cloud native versions in existing pages
  • fill in page metadata for search results

Example prompts for the agent

  • Describe the Deployment and Service manifests for the new service and add a page under docs/
  • Draft the networking section for our MkDocs site and propose the structure
  • Check docs/install.md: are the Kubernetes versions current and the tone consistent?

How to install kubernetes-mkdocs-documentation-cursorrules-prompt

Manually: put the files in place

.cursor/rules/kubernetes-mkdocs-documentation-cursorrules-prompt.mdc

Frontmatter: description, globs, alwaysApply

Step by step, with commands for each platform: Cursor rules: .mdc files, four modes and what replaced .cursorrules

Questions about kubernetes-mkdocs-documentation-cursorrules-prompt

How do I install kubernetes-mkdocs-documentation-cursorrules-prompt in Cursor?

Place the file at .cursor/rules/kubernetes-mkdocs-documentation-cursorrules-prompt.mdc. Then enable the rule manually, since the frontmatter sets alwaysApply: false.

What does kubernetes-mkdocs-documentation-cursorrules-prompt do?

It gives the agent a technical writer role for Kubernetes and cloud native documentation. The agent drafts and edits Markdown and MkDocs pages, watching style, metadata and version accuracy.

Which files does the rule apply to?

All of them. The frontmatter declares globs: **/*, so the rule can also fire on code files, not just documentation pages.

Source text

kubernetes-mkdocs-documentation-cursorrules-prompt.mdc · CC0-1.0
---
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.

© PatrickJS · CC0-1.0 · PatrickJS/awesome-cursorrules

Similar IDE rules

All IDE rules for Writing and docs →

From the same set68

netlify-official-cursorrules-prompt-file A Cursor rule that hands the agent Netlify's official conventions: function types, environment access, and no stray CORS headers. ★ 41,011repo stars nativescript-cursorrules-prompt-file A Cursor rule that tells the agent how to structure a NativeScript project and which libraries to reach for. ★ 41,011repo stars manifest-yaml-cursorrules-prompt-file A Cursor rule that tells the agent how to scaffold a small Manifest backend: project setup, the manifest/backend.yml file and limits on entities. ★ 41,011repo stars laravel-php-83-cursorrules-prompt-file A Cursor rule that walks the agent through building Laravel packages: plan, directory layout, naming standards, tests and docs. ★ 41,011repo stars knative-istio-typesense-gpu-cursorrules-prompt-fil A Cursor rule that turns the assistant into a helper for serverless projects built on Knative with Istio, Typesense and HTMX. Useful when your search app runs on that stack. ★ 41,011repo stars javascript-chrome-apis-cursorrules-prompt-file A Cursor rule that points the AI agent at Chrome extension work: manifest, architecture, Chrome API usage. ★ 41,011repo stars htmx-go-fiber-cursorrules-prompt-file A Cursor rule for Go projects built on Fiber with HTMX: it pins down folder layout, routing and template rendering so the agent stops improvising. ★ 41,011repo stars htmx-django-cursorrules-prompt-file A Cursor rule that keeps the agent on Django rails while it writes HTMX code: templates, forms, CSRF, class-based views. ★ 41,011repo stars

Project sponsors

Companies that keep this analytics open
Gold sponsor

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor