Abdulmuizz HamzatandRotimi Best
b599f1a017
* Update documentation for ClassroomIO: change Fumadocs to Blume, revise MDX format conventions, and clarify sidebar navigation requirements. * docs: update README and scripts for improved preview and error handling * docs: update Discord link in configuration and documentation * docs: add token-auth route and update documentation formatting * Fix formatting in auto-comment-issues.yml * Fix JSON syntax by adding a comma * fix(docs): declare Blume's Astro build deps so Cloudflare build resolves them blume build generates an Astro project under apps/docs/.blume/ that imports astro, @astrojs/mdx, @tailwindcss/vite, tailwindcss, @tailwindcss/typography, @shikijs/twoslash and @scalar/astro. Under pnpm's isolated node_modules these are nested inside blume and not resolvable from the docs app, so a clean --frozen-lockfile build (Cloudflare) fails at 'Cannot find module astro/config'. Declare them directly in @cio/docs, pinned to blume's resolved versions. * refactor(docs): update API reference paths and documentation for clarity * fix: change platofrm url to docs home page * Refactor documentation for self-hosting ClassroomIO - Removed the Supabase Cloud setup guide as it is no longer needed. - Updated the Enterprise SSO documentation to include a reference link for SSO & licensing. - Added new documentation for Content Security Policy (CSP) configuration. - Created a new section for configuring SMTP for email notifications. - Introduced a comprehensive configuration index for self-hosted ClassroomIO, detailing environment variables and their usage. - Added documentation for optional integrations including Google OAuth, OpenAI, and Unsplash. - Documented the generation and usage of required secrets for ClassroomIO. - Created a section for SSO & licensing, detailing the requirements for Enterprise features. - Added object storage configuration documentation, covering both bundled MinIO and external S3-compatible services. - Documented versioning and upgrade processes for ClassroomIO. - Updated the Coolify and Docker self-hosting guides to streamline configuration references and upgrade instructions. - Enhanced the Railway self-hosting guide with links to relevant configuration sections. - Updated token authentication documentation to reference SSO & licensing. * Add comprehensive guides for ClassroomIO features and functionalities - Introduced a new guide for the Student Dashboard, detailing navigation and features available to students. - Added a guide on using Tags for organizing and filtering courses within ClassroomIO. - Created a guide on how to take attendance in courses, including marking attendance and related functionalities. - Developed a Terminology guide to clarify key terms used throughout ClassroomIO. - Implemented a Token Auth guide for signing users into ClassroomIO from external applications using JWT. - Added instructions for using math in the editor with LaTeX support. - Created a guide for customizing the welcome email sent to students upon enrollment in courses. - Added a guide explaining what ClassroomIO is and its key features. - Updated the home documentation to provide a clearer overview of ClassroomIO and its resources. - Enhanced self-hosted configuration documentation with a new guide for deploying ClassroomIO on Dokploy. - Updated links in the self-hosted configuration documentation for better navigation. - Added new images to support the Dokploy deployment guide. - Updated asset packaging script to handle redirects for the new guide structure. - Fixed footer link to point to the correct Getting Started guide. * chore: uprage version * feat(docs): add DigitalOcean deployment guide and flatten guides structure - Add a guide for deploying ClassroomIO on DigitalOcean using Docker Compose and Caddy for automatic HTTPS. - List DigitalOcean as a deployment option in the self-hosting index. - Move guides out of content/docs/guides into content/docs (student-dashboard, tags, terminology, token-auth, what-is-classroomio, audience, cohorts, community, course, enterprise-sso, mcp, organization, quickstart/*). - Rename home.mdx to index.mdx. - Update package-assets script to emit redirects for the old guides paths. --------- Co-authored-by: Rotimi Best <[email protected]>
87 lines
4.2 KiB
Plaintext
87 lines
4.2 KiB
Plaintext
---
|
|
title: Student Dashboard
|
|
description: Learn how students navigate the LMS, including Home, My Learning, Cohorts, and Explore.
|
|
---
|
|
|
|
The student dashboard (LMS) is where students open courses, track progress, and discover new content. If you are an admin, this page helps you explain what students see after they join your organization.
|
|
|
|
Students reach the LMS after they sign in on your academy. The left sidebar lists the main areas below. **Exercise** and **Community** only appear when your organization has those features enabled.
|
|
|
|
## LMS navigation at a glance
|
|
|
|
| Area | Path | What it shows |
|
|
| --- | --- | --- |
|
|
| **Home** | `/lms` | Enrolled courses with progress |
|
|
| **My Learning** | `/lms/mylearning` | Enrolled courses only, grouped by status |
|
|
| **Cohorts** | `/lms/cohorts` | Cohorts the student belongs to |
|
|
| **Explore** | `/lms/explore` | Published courses they are not enrolled in yet |
|
|
| **Exercise** | `/lms/exercises` | Exercises (if enabled for your org) |
|
|
| **Community** | `/lms/community` | Community (if enabled for your org) |
|
|
| **Settings** | `/lms/settings` | Profile and integrations |
|
|
|
|
## Home
|
|
|
|
**Home** is the default landing page after a student signs in. It shows courses they are already enrolled in, along with progress indicators so they can pick up where they left off.
|
|
|
|
Use Home when you want a quick overview of everything the student is actively taking.
|
|
|
|
## My Learning
|
|
|
|
**My Learning** focuses only on enrolled courses. Students can switch between tabs such as **In progress** and **Complete** to filter their list.
|
|
|
|
| View | Best for |
|
|
| --- | --- |
|
|
| **Home** | Progress at a glance across enrolled courses |
|
|
| **My Learning** | Browsing and filtering enrolled courses by completion status |
|
|
|
|
Both show enrolled courses. My Learning adds clearer filtering for students managing a longer list.
|
|
|
|
## Explore
|
|
|
|
**Explore** lists **published, active courses** in your organization that the student has **not** enrolled in yet. Each card links to the course landing page so they can read details and enroll (if enrollment is open).
|
|
|
|
:::info[Explore is a catalog, not an enrollment gate]
|
|
A course can appear in Explore even when public self-enrollment is turned off. **Allow New Students** controls whether someone can join from the landing page, not whether the course is visible in Explore. To restrict who can join, see [How Course Enrollment Works](/guides/course-enrollment).
|
|
:::
|
|
|
|
Explore is useful when you want students to discover optional or elective courses without assigning them manually.
|
|
|
|
## Cohorts
|
|
|
|
**Cohorts** are separate from individual courses. A cohort groups courses under shared goals (for example, complete all courses in an onboarding track). Students who belong to a cohort see it under **Cohorts** in the LMS.
|
|
|
|
| Concept | Where students see it |
|
|
| --- | --- |
|
|
| Individual enrolled courses | Home, My Learning |
|
|
| Courses not yet joined | Explore |
|
|
| Multi-course tracks with goals | Cohorts |
|
|
|
|
For how admins create cohorts and set goals, see [Cohorts](/cohorts).
|
|
|
|
## What students see right after enrolling
|
|
|
|
When a student enrolls in a course (from a landing page, invite link, or admin assignment):
|
|
|
|
1. They are added to the course **group** immediately.
|
|
2. The course appears on **Home** and **My Learning**.
|
|
3. It no longer appears in **Explore** (because they are enrolled).
|
|
4. They can open lessons, exercises, and materials from the course sidebar.
|
|
|
|
If you added them from **People** but they have not signed in yet, they may show as **Pending** in the admin People list until they accept the invite or create an account.
|
|
|
|
## Courses vs cohorts: quick comparison
|
|
|
|
| Question | Answer |
|
|
| --- | --- |
|
|
| Where do I see courses I am taking? | **Home** or **My Learning** |
|
|
| Where do I find courses I have not joined? | **Explore** |
|
|
| Where do I see structured learning paths? | **Cohorts** |
|
|
| Can one student use all three views? | Yes. They work together. |
|
|
|
|
## Related guides
|
|
|
|
- [How Course Enrollment Works](/guides/course-enrollment) — how students join courses and what settings control access
|
|
- [How to Invite Students](/guides/invite-students) — send enrollment links by email
|
|
- [Cohorts](/cohorts) — multi-course tracks and goals for admins
|
|
- [Create a Course Landing Page](/guides/course-landingpage) — what prospects see before enrolling
|