Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# GitHub Copilot Instructions for Rundeck Documentation

You are an AI assistant helping maintain the Rundeck documentation site.

## Project Context
- This repository contains documentation for Rundeck, an open-source job scheduler and runbook automation tool
- Documentation is primarily written in Markdown and organized by product versions
- Documentation follows a specific structure with product versions, features, and administration guides
- Documentation is built using VuePress 2 and the Hope Theme.

## Key Documentation Guidelines
- Use clear, concise language
- Follow technical writing best practices
- Include practical examples where appropriate
- Ensure all code examples are properly formatted and functional
- Maintain consistent terminology throughout the documentation
- Use proper heading hierarchy (H1 > H2 > H3)
- Include descriptive alt text for images

## Common Tasks
- Creating new documentation pages
- Updating existing documentation for new releases
- Fixing formatting issues in Markdown files
- Improving code examples
- Enhancing clarity of technical explanations
- Cross-referencing related documentation

## Directory Structure
- `/docs/` - Main documentation content
- `/docs/manual/` - Core product documentation
- `/docs/administration/` - Administration guides
- `/docs/api/` - API documentation
- `/docs/developer/` - Developer documentation
- `/docs/learning/` - Tutorials and learning resources

## Markdown Guidelines
- Use ATX-style headers (`#` for H1, `##` for H2)
- Code blocks should specify language for proper syntax highlighting
- Use numbered lists for sequential steps
- Use bullet points for non-sequential items
- Tables should have headers and consistent column formatting