Christian Krakau-Louis
6306abf6d9
- Created architecture overview in development/architecture.md - Added installation guide in getting-started/installation.md - Developed user guide with detailed instructions in user-guide/overview.md, user-guide/teams.md, user-guide/qr-codes.md - Implemented social login setup documentation in social_login_setup.md - Updated index.md to include links to new documentation sections - Configured mkdocs.yml for site structure and theme - Added requirements.txt for documentation dependencies
2.5 KiB
LeagueLedger Documentation
Welcome to the official documentation for LeagueLedger, a comprehensive team management and points tracking system designed for organizing competitions, tracking achievements, and managing team-based events.
About LeagueLedger
LeagueLedger is a flexible platform that helps event organizers, team managers, and participants track points, achievements, and standings. Whether you're running pub quizzes, sports leagues, or any team-based competition, LeagueLedger provides the tools to streamline your operations.
Key Features
- Team Management: Create, join, and manage teams with flexible access controls
- Points Tracking: Award points to teams and individuals through various mechanisms
- QR Code System: Generate and scan QR codes for easy point attribution
- Achievements: Recognize accomplishments with customizable achievements
- Leaderboard: Real-time standings for teams and individuals
- Event Management: Organize and track attendance for events
- Social Login: Multiple authentication options for streamlined user access
- Responsive Design: Works on desktop and mobile devices
Documentation Structure
This documentation is organized into several sections:
- Getting Started: Installation, configuration, and quick start guide
- User Guide: Comprehensive instructions for end users
- Administration: Managing users, teams, QR codes, and events
- Development: Technical details for developers
- Deployment: Guides for deploying to production environments
- Integrations: Working with external services
Quick Links
Support
If you encounter any issues or have questions not covered in this documentation, please:
- Check the FAQ section
- Search for similar issues in our GitHub repository
- Open a new issue if your problem hasn't been addressed
Contributing
We welcome contributions to both the LeagueLedger project and its documentation. See our Contributing Guide for more information.