π Official documentation for BotTrapper Discord bot management system, including Terms of Service and Privacy Policy.
Documentation is available at: https://bottrapper.me/
# Install dependencies
npm install
# Start development server
npm run dev
# View documentation locally
open http://localhost:5173
# Build the Docker image
docker build -t bottrapper-docs .
# Run the container
docker run -p 80:80 --name bottrapper-docs bottrapper-docs
# Production deployment
docker-compose -f docker-compose.prod.yml up -d
The documentation can be configured with the following environment variables:
VITE_API_URL
: API base URL (default: https://api.bottrapper.me)
discord-bot-docs/
βββ .vitepress/
β βββ config.js # VitePress Configuration
β βββ theme/ # Custom Theme (optional)
βββ public/ # Static Assets
β βββ favicon.ico
β βββ logo.png
βββ api/ # API Documentation
βββ commands/ # Bot Commands Guide
βββ dashboard/ # Dashboard Guide
βββ deployment/ # Deployment Guide
βββ tos.md # Terms of Service
βββ dataprivacy.md # Privacy Policy
βββ getting-started.md # Getting Started
βββ installation.md # Installation Guide
βββ changelog.md # Changelog
βββ index.md # Homepage
The documentation includes German legal pages for GDPR compliance:
- Terms of Service:
/tos
- Nutzungsbedingungen - Privacy Policy:
/dataprivacy
- DatenschutzerklΓ€rung
These pages are also integrated into the BotTrapper dashboard and accessible via Discord commands.
- Documentation:
https://bottrapper.me/
- Terms of Service:
https://bottrapper.me/tos
- Privacy Policy:
https://bottrapper.me/dataprivacy
The Docker container includes a health check endpoint:
# Check container health
docker exec bottrapper-docs wget --no-verbose --tries=1 --spider http://localhost/
The documentation includes:
- Discord-themed colors and styling
- Mobile-responsive design
- Search functionality
- Legal footer with links to Terms and Privacy Policy
- Automated last-update timestamps
The documentation is integrated with the main BotTrapper ecosystem:
/tos
- Shows Terms of Service embed with link/data
- Shows Privacy Policy embed with link
- Footer links to legal pages
- Public routes for
/tos
and/dataprivacy
- Documentation for all REST API endpoints
- OAuth2 setup instructions
- Feature management guides
- Fork the repository
- Create a feature branch
- Make your changes
- Test locally with
npm run dev
- Create a Pull Request
MIT License - see LICENSE for details