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.
.cursor/rules/kubernetes-mkdocs-documentation-cursorrules-prompt.mdcWhat 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.mdcFrontmatter: description, globs, alwaysApply
Manually: put the files in place
.claude/rules/kubernetes-mkdocs-documentation-cursorrules-prompt.mdThe paths frontmatter field limits the files: move globs from the source into paths
AGENTS.md
Codex reads AGENTS.md: paste the rule text there
Manually: put the files in place
.github/instructions/kubernetes-mkdocs-documentation-cursorrules-prompt.instructions.mdThe applyTo field sets which files it applies to: move globs from the source into applyTo
Manually: put the files in place
.devin/rules/kubernetes-mkdocs-documentation-cursorrules-prompt.mdManually: put the files in place
.clinerules/kubernetes-mkdocs-documentation-cursorrules-prompt.mdStep 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