This directory contains documentation for the Rhesis platform. The full documentation is hosted at docs.rhesis.ai.
- Self-Hosting Guide: Complete guide for running Rhesis with Docker Compose
- Environment Setup: Local development environment setup
- Backend: Documentation for the backend API and services
- Frontend: Documentation for the frontend application
- SDK: Documentation for the Python SDK
- Worker: Documentation for the background processing and task system
If you want to run Rhesis in production or for evaluation, start with the Self-Hosting Guide.
If you're contributing to Rhesis or setting up a local development environment, see the Environment Setup Guide.
If you're building applications that integrate with Rhesis, check out the SDK Documentation.
To work on the documentation locally:
cd docs/src
# Install dependencies
make install
# Run development server
npm run dev
# Linting and formatting
make lint # Run all checks (ESLint + Prettier)
make lint-fast # Same as lint (no build needed)
make format # Auto-fix formatting issues
make format-check # Check formatting only
make eslint # Run ESLint onlyThe documentation site will be available at http://localhost:3001.
Please refer to docs.rhesis.ai for the complete and up-to-date documentation. Each section has detailed information with guides, tutorials, and API references.