-
Notifications
You must be signed in to change notification settings - Fork 174
Create copilot-instructions.md #1674
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.