mirror of
https://github.com/plexguide/Huntarr.io.git
synced 2026-04-29 07:42:44 -04:00
dcee82748b
- Update Python version from 3.9/3.10 to 3.12 across all platforms - Upgrade Flask from 3.0.0 to 3.1.2 - Upgrade requests from 2.31.0 to 2.32.5 - Upgrade waitress from 2.1.2 to 3.0.2 - Upgrade pyyaml from 6.0 to 6.0.2 - Update documentation to reflect Python 3.12+ requirement - Update GitHub Actions workflows for macOS (ARM/Intel) and Windows - Update Dockerfile base image to python:3.12-slim - Update Windows setup script to require Python 3.12+ This addresses CVE's in requests and waitress, and ensures compatibility with Python 3.12 which provides improved performance and security.
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.
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:
- Make changes to files in the
/docsdirectory - Submit a pull request to the main branch
- 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:
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.