Mirror of https://github.com/roostorg/osprey
github.com/roostorg/osprey
1# Osprey Documentation
2
3Welcome to the Osprey documentation! This folder contains important information about contributing to and working with this project.
4
5## Getting Started
6
7New to the project? We recommend reading the documentation in this order:
8
91. **[Code of Conduct](https://github.com/roostorg/.github/blob/main/CODE_OF_CONDUCT.md)** - Understand our community standards
102. **[Contributing Guidelines](https://github.com/roostorg/.github/blob/main/CONTRIBUTING.md)** - Learn how to contribute
113. **[Development Guide](DEVELOPMENT.md)** - Set up your development environment and get started using Osprey
124. **[Osprey UI](UI.md)** - Understand how to use and navigate the UI
13
14## Reporting a Bug or Issue
15
16Found a bug or have a feature request? We'd love to hear from you! When opening an issue, please use our templates:
17
18* [Bug Report](https://github.com/roostorg/osprey/issues/new?template=bug_report.md)
19* [Feature Request](https://github.com/roostorg/osprey/issues/new?template=feature_request.md)
20* [Submit an Egg (new tool idea) to ROOST!](https://github.com/roostorg/osprey/issues/new?template=documentation.md)
21
22## Need Help?
23
24If you can't find what you're looking for in these documents, please:
25- Check the project's main README.md
26- Open an issue with your question
27- Reach out to the maintainers
28
29---
30
31Thank you for your interest in contributing to our project!