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
49 lines
2.5 KiB
Markdown
49 lines
2.5 KiB
Markdown
# 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](getting-started/installation.md)**: Installation, configuration, and quick start guide
|
|
- **[User Guide](user-guide/overview.md)**: Comprehensive instructions for end users
|
|
- **[Administration](administration/admin-panel.md)**: Managing users, teams, QR codes, and events
|
|
- **[Development](development/architecture.md)**: Technical details for developers
|
|
- **[Deployment](deployment/docker.md)**: Guides for deploying to production environments
|
|
- **[Integrations](integrations/social-login.md)**: Working with external services
|
|
|
|
## Quick Links
|
|
|
|
- [Installation Guide](getting-started/installation.md)
|
|
- [User Accounts](user-guide/user-accounts.md)
|
|
- [Team Management](user-guide/teams.md)
|
|
- [QR Code System](user-guide/qr-codes.md)
|
|
- [Admin Panel](administration/admin-panel.md)
|
|
|
|
## Support
|
|
|
|
If you encounter any issues or have questions not covered in this documentation, please:
|
|
|
|
1. Check the [FAQ section](faq.md)
|
|
2. Search for similar issues in our [GitHub repository](https://github.com/yourusername/leagueledger/issues)
|
|
3. 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](contributing.md) for more information. |