mirror of
https://github.com/plexguide/Huntarr.io.git
synced 2026-02-23 07:08:45 -06:00
Admin9705
42 lines
1.2 KiB
Markdown
42 lines
1.2 KiB
Markdown
# Huntarr.io Documentation
|
|
|
|
This directory contains the official documentation for the Huntarr.io project, which is automatically published to [https://plexguide.github.io/Huntarr.io/docs](https://plexguide.github.io/Huntarr.io/docs).
|
|
|
|
## Structure
|
|
|
|
The documentation is built using GitHub Pages with files directly from the `/docs` folder. The main entry point is `index.html`.
|
|
|
|
## Contributing
|
|
|
|
To contribute to the documentation:
|
|
|
|
1. Make changes to files in the `/docs` directory
|
|
2. Submit a pull request to the main branch
|
|
3. Once approved and merged, GitHub Actions will automatically deploy the changes
|
|
|
|
## Local Testing
|
|
|
|
To test documentation locally, you can use Python's built-in HTTP server:
|
|
|
|
```bash
|
|
cd /path/to/Huntarr.io/docs
|
|
python -m http.server 8000
|
|
```
|
|
|
|
Then open your browser to `http://localhost:8000`.
|
|
|
|
## Documentation Plan
|
|
|
|
This documentation will eventually include:
|
|
|
|
- Installation guides
|
|
- Configuration instructions
|
|
- Feature documentation for all apps (Sonarr, Radarr, Lidarr, Readarr, Whisparr, etc.)
|
|
- Frequently Asked Questions
|
|
- Troubleshooting tips
|
|
- API documentation
|
|
|
|
## Contact
|
|
|
|
If you have questions about the documentation, please open an issue on GitHub or join our [Discord](https://discord.com/invite/PGJJjR5Cww).
|