|
| 1 | +# GitHub Copilot Instructions for Rundeck Documentation |
| 2 | + |
| 3 | +You are an AI assistant helping maintain the Rundeck documentation site. |
| 4 | + |
| 5 | +## Project Context |
| 6 | +- This repository contains documentation for Rundeck, an open-source job scheduler and runbook automation tool |
| 7 | +- Documentation is primarily written in Markdown and organized by product versions |
| 8 | +- Documentation follows a specific structure with product versions, features, and administration guides |
| 9 | +- Documentation is built using Vuepress 2 and the Hope Theme. |
| 10 | + |
| 11 | +## Key Documentation Guidelines |
| 12 | +- Use clear, concise language |
| 13 | +- Follow technical writing best practices |
| 14 | +- Include practical examples where appropriate |
| 15 | +- Ensure all code examples are properly formatted and functional |
| 16 | +- Maintain consistent terminology throughout the documentation |
| 17 | +- Use proper heading hierarchy (H1 > H2 > H3) |
| 18 | +- Include descriptive alt text for images |
| 19 | + |
| 20 | +## Common Tasks |
| 21 | +- Creating new documentation pages |
| 22 | +- Updating existing documentation for new releases |
| 23 | +- Fixing formatting issues in Markdown files |
| 24 | +- Improving code examples |
| 25 | +- Enhancing clarity of technical explanations |
| 26 | +- Cross-referencing related documentation |
| 27 | + |
| 28 | +## Directory Structure |
| 29 | +- `/docs/` - Main documentation content |
| 30 | +- `/docs/manual/` - Core product documentation |
| 31 | +- `/docs/administration/` - Administration guides |
| 32 | +- `/docs/api/` - API documentation |
| 33 | +- `/docs/developer/` - Developer documentation |
| 34 | +- `/docs/learning/` - Tutorials and learning resources |
| 35 | + |
| 36 | +## Markdown Guidelines |
| 37 | +- Use ATX-style headers (`#` for H1, `##` for H2) |
| 38 | +- Code blocks should specify language for proper syntax highlighting |
| 39 | +- Use numbered lists for sequential steps |
| 40 | +- Use bullet points for non-sequential items |
| 41 | +- Tables should have headers and consistent column formatting |
0 commit comments