kubernetes-mkdocs-documentation-cursorrules-prompt — правило
Правило задаёт Cursor роль технического писателя: агент пишет документацию по Kubernetes и cloud native в Markdown и MkDocs.
.cursor/rules/kubernetes-mkdocs-documentation-cursorrules-prompt.mdcЧто делает kubernetes-mkdocs-documentation-cursorrules-prompt
Правило включается в Cursor и меняет поведение агента при работе с документацией. Он ведёт себя как технический писатель, который разбирается в Kubernetes и cloud native, и опирается на актуальные стабильные версии Kubernetes, cloud native-инструментов и MkDocs.
Внутри файла — набор разделов: стиль и структура документации, работа с MkDocs, создание контента, техническая точность, метаданные и SEO, совместная работа и контроль версий. Отдельно оговорено, что документация должна быть полной и точной по всем запрошенным темам, без отговорок.
В frontmatter стоит globs: **/*, то есть правило видит любой файл проекта, а alwaysApply: false — оно не подключается само. Это повод проверить: если вы ждали, что Cursor начнёт следовать правилу сразу после установки, ничего не произойдёт, пока вы не включите его вручную.
Какие задачи решает
- описать новый сервис Kubernetes так, чтобы текст понял человек без опыта с кластерами
- собрать структуру разделов для сайта документации на MkDocs
- привести разрозненные заметки к единому стилю Markdown
- проверить, что в тексте нет устаревших версий Kubernetes и cloud native-инструментов
- заполнить метаданные страниц для поисковой выдачи
Примеры запросов агенту
- Опиши манифесты Deployment и Service для нового сервиса и добавь страницу в docs/
- Собери структуру раздела про networking в MkDocs и напиши черновик
- Проверь страницу docs/install.md: версии Kubernetes актуальные, стиль ровный?
Как установить kubernetes-mkdocs-documentation-cursorrules-prompt
Вручную: положить файлы
.cursor/rules/kubernetes-mkdocs-documentation-cursorrules-prompt.mdcВо frontmatter: description, globs, alwaysApply
Вручную: положить файлы
.claude/rules/kubernetes-mkdocs-documentation-cursorrules-prompt.mdПоле paths во frontmatter ограничивает файлы: globs из источника → paths
AGENTS.md
Codex читает AGENTS.md: вставьте текст правила туда
Вручную: положить файлы
.github/instructions/kubernetes-mkdocs-documentation-cursorrules-prompt.instructions.mdПоле applyTo задаёт, к каким файлам применять: globs из источника → applyTo
Вручную: положить файлы
.devin/rules/kubernetes-mkdocs-documentation-cursorrules-prompt.mdВручную: положить файлы
.clinerules/kubernetes-mkdocs-documentation-cursorrules-prompt.mdПо шагам, с командами для каждой платформы: Cursor rules: файлы .mdc, четыре режима и замена .cursorrules
Вопросы о kubernetes-mkdocs-documentation-cursorrules-prompt
Как установить kubernetes-mkdocs-documentation-cursorrules-prompt в Cursor?
Положите файл по пути .cursor/rules/kubernetes-mkdocs-documentation-cursorrules-prompt.mdc. После этого включите правило вручную: в frontmatter стоит alwaysApply: false.
Что делает это правило?
Задаёт агенту роль технического писателя по Kubernetes и cloud native. Он пишет и правит документацию в Markdown и MkDocs, следит за стилем, метаданными и актуальностью версий.
На какие файлы оно распространяется?
На все: в frontmatter указано globs: **/*. Правило может сработать и на файлах кода, а не только на страницах документации.
Исходный текст
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