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
3.5 KiB
LeagueLedger User Guide
Welcome to the LeagueLedger User Guide. This section provides detailed instructions on how to use LeagueLedger as an end user.
Getting Started as a User
Creating an Account
To use LeagueLedger, you'll first need to create an account:
- Navigate to the LeagueLedger homepage
- Click on the "Sign Up" or "Register" button
- Fill in the required information:
- Username
- Email address
- Password
- Complete the verification process through the email sent to your address
- Log in with your new credentials
Logging In
You can log in using:
- Your username and password
- Social login (if configured by your administrator) via Google, GitHub, Microsoft, and other supported providers
Core Features
User Dashboard
After logging in, you'll see your dashboard with:
- Your personal points totals
- Teams you're a member of
- Recent activities and achievements
- Upcoming events
- Quick access to common actions
Teams
Teams are the core organizational unit in LeagueLedger:
- Joining Teams: Find teams through search or receive invitations
- Creating Teams: Start your own team and invite others
- Team Management: View team statistics, achievements, and members
QR Codes and Points
Points in LeagueLedger are typically awarded through QR codes:
- Scanning QR Codes: Use the scan feature to capture QR codes at events
- Points History: Track all your earned points and achievements
- Team Points: View how your contributions affect team standings
Events
LeagueLedger tracks various events:
- Upcoming Events: See what events are scheduled
- Event Registration: Sign up for events individually or as a team
- Event Attendance: Check in to events using QR codes
Leaderboards
Track standings and achievements:
- Individual Leaderboards: See how you rank among all participants
- Team Leaderboards: View team rankings
- Event-specific Leaderboards: Standings for particular events
User Settings
Profile Management
Customize your experience through the profile settings:
- Navigate to "My Account" or "Settings"
- Update your:
- Profile picture
- Personal information
- Email preferences
- Notification settings
Account Security
Manage your account security:
- Change your password
- Enable/disable social login connections
- View active sessions
Navigation Guide
Main Menu
The main menu provides access to all major features:
- Dashboard: Your personal overview
- Teams: Access to teams you belong to
- Events: Upcoming and past events
- QR Scanner: Tool to scan QR codes
- Leaderboards: Overall standings
- Profile: Your personal settings
Mobile Navigation
On mobile devices, the menu is accessible through the hamburger icon (≡) in the top corner.
Getting Help
If you encounter any issues while using LeagueLedger:
- Check the FAQ section
- Contact your organization's administrator
- Submit a support request through the "Help" section
Next Steps
For more detailed information about specific features, please refer to the following guides:
- User Accounts: Detailed account management information
- Teams: Complete team management guide
- QR Codes: Everything about the QR code system
- Points & Achievements: How points and achievements work
- Leaderboard: Understanding the leaderboard system
- Events: Comprehensive events guide