Skip to content

BotTrapper/discord-bot-docs

Repository files navigation

BotTrapper Documentation

πŸ“š Official documentation for BotTrapper Discord bot management system, including Terms of Service and Privacy Policy.

🌐 Live Documentation

Documentation is available at: https://bottrapper.me/

πŸš€ Local Development

# Install dependencies
npm install

# Start development server
npm run dev

# View documentation locally
open http://localhost:5173

🐳 Docker Deployment

Build and Deploy

# Build the Docker image
docker build -t bottrapper-docs .

# Run the container
docker run -p 80:80 --name bottrapper-docs bottrapper-docs

Using Docker Compose

# Production deployment
docker-compose -f docker-compose.prod.yml up -d

Environment Variables

The documentation can be configured with the following environment variables:

πŸ“ Structure

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

οΏ½ Legal Pages

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.

πŸ”— Production URLs

  • Documentation: https://bottrapper.me/
  • Terms of Service: https://bottrapper.me/tos
  • Privacy Policy: https://bottrapper.me/dataprivacy

πŸ₯ Health Check

The Docker container includes a health check endpoint:

# Check container health
docker exec bottrapper-docs wget --no-verbose --tries=1 --spider http://localhost/

🎨 Customization

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

οΏ½ Integration with BotTrapper

The documentation is integrated with the main BotTrapper ecosystem:

Discord Bot Commands

  • /tos - Shows Terms of Service embed with link
  • /data - Shows Privacy Policy embed with link

Dashboard Integration

  • Footer links to legal pages
  • Public routes for /tos and /dataprivacy

API Integration

  • Documentation for all REST API endpoints
  • OAuth2 setup instructions
  • Feature management guides

πŸ“ Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Test locally with npm run dev
  5. Create a Pull Request

πŸ“„ License

MIT License - see LICENSE for details

About

πŸ“š Complete Documentation for Discord Bot Project using VitePress

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages