Official Documentation
The Operator's Manual.
Everything you need to know to harness the full power of the Study Nexus engine. Learn how to import roadmaps, sync your weekly timetables, track your deep focus sessions, and customize your instance.
1. User Guide
Instructions for navigating the platform and tracking your progress.
Getting Started
Study Nexus is designed to be your central operating system for learning. To begin, you'll need an account. If the instance is set to Invite-Only, you must acquire an invite code from an existing user or community administrator.
Once logged in, your primary view is the Dashboard. This is your command center, displaying your current active roadmap, daily scheduled tasks, and learning velocity heatmaps spanning a full 365 days.
The Roadmap Builder
Roadmaps are the core of Study Nexus. Instead of manually typing out hundreds of tasks, you can instantly generate entire curriculums using the Markdown Import feature.
// Example Markdown Table Format
| Serial No | Milestone | Description | Tasks | Duration | |-----------|--------------|------------------|-----------------------|----------| | 1 | React Basics | Learn components | JSX, Props, State | 7 | | 2 | API Requests | Fetching data | Fetch API, useEffect | 5 |
Paste a table like the one above directly into the Builder. You can ask ChatGPT or Claude to generate these tables for any subject you want to learn. The system will automatically parse the days, topics, and expected durations.
Timetable & Schedule
The Timetable allows you to aggregate your entire schedule visually. You can import external calendars (like Google Calendar, Outlook, or any iCal feed) and create manual recurring blocks for classes or study sessions, ensuring you stay organized across multiple subjects.
- External Calendars: Live synchronization with Google Calendar, Outlook, and iCal URLs.
- Class Blocks: Recurring weekly events to map out your semester or work week.
- One-off Tasks: Individual deadlines or homework assignments that exist outside your roadmaps.
Note: Tasks and calendar events scheduled for today will automatically appear on your main Dashboard for easy tracking.
Focus Engine & Analytics
The global timer is persistent across your entire session. You can start it from the Dashboard or any Roadmap page. Use the cycle button (arrows) to switch between our three tracking modes:
- Continuous (Stopwatch): Counts up from zero. Best for open-ended study sessions where you just want to track total time spent.
- Focus (Countdown): A single countdown timer. Set a specific goal (e.g., 45 minutes) and it will alert you when time is up.
- Pomodoro (Intervals): Auto-looping countdowns. It automatically alternates between focus periods (e.g., 25 mins) and short breaks (e.g., 5 mins) to prevent burnout.
When you finish a session, you will be prompted to log your completion. You can record the actual time spent, write detailed reflections, and log your mood. This data feeds directly into your velocity charts, streaks, and 365-day heatmaps. If you ever need a break, use your Streak Freezes to preserve your momentum.
Sharing & Cloning
Study Nexus is built for community growth. If you create a phenomenal roadmap for learning a complex subject, you can make it public. Doing so generates a unique shareable URL.
Other users who visit your public roadmap can view your curriculum and click "Clone" to instantly add an identical, fresh copy into their own private workspace—giving them a massive head start on their learning journey.
Settings & Data Vault
Customize your experience in the Settings page. Set a custom username, adjust your local timezone to ensure accurate streak tracking, and tweak your default timer preferences.
Your data belongs to you. In the Data Vault section, you can perform full JSON exports of all your roadmaps, logs, and analytics at any time. You can also wipe your account clean if you wish to start over.
2. Administrator Guide
Managing users, access control, and server settings.
Instance Control & Security
Invite Codes: If your instance is set to Invite-Only in the `src/lib/constants.ts` or via environment variables, new users cannot register without a code. Admins can generate these codes directly from the database or via the internal admin dashboard (if enabled).
Maintenance Mode: The application can be locked down by navigating to the Vercel edge config or setting `MAINTENANCE_MODE=true` in your `.env` file. Users will be redirected to a `/maintenance` page automatically.
Role Management: To promote a user to `ADMIN`, you must manually edit their database record or use the Prisma Studio `npx prisma studio`. Admins bypass invite requirements and have full access to all public and private roadmaps.