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 <best@classroomio.com>
53 lines
2.3 KiB
Plaintext
53 lines
2.3 KiB
Plaintext
---
|
|
title: Cohorts
|
|
description: Learn what Cohorts are in ClassroomIO, how goals work, and what students see in the Cohorts view.
|
|
---
|
|
|
|
**Cohorts** group multiple courses into a structured learning path. Use them when students need to complete a set of courses toward a shared outcome (onboarding, certification prep, role-based training). Individual courses still live in the LMS; cohorts add goals and a dedicated **Cohorts** view for students.
|
|
|
|
## Cohorts vs courses
|
|
|
|
| Concept | Scope | Student view |
|
|
| --- | --- | --- |
|
|
| **Course** | Single content container with lessons | **Home**, **My Learning**, **Explore** |
|
|
| **Cohort** | Multiple courses with shared goals | **Cohorts** in the LMS |
|
|
|
|
A student can be enrolled in courses without belonging to a cohort, and in a cohort that references several courses. See [Student Dashboard](/student-dashboard) for how those views fit together.
|
|
|
|
## Admin workflow
|
|
|
|
From the admin dashboard:
|
|
|
|
1. Create a cohort and add courses to it.
|
|
2. Configure cohort **Settings** (metadata, visibility, assignments).
|
|
3. Add **Goals** that define what success looks like.
|
|
4. Assign students to the cohort (existing students or by email invite).
|
|
|
|
Students assigned to a cohort see it under **Cohorts** in the LMS.
|
|
|
|
## Cohort goal types
|
|
|
|
Goals measure progress across the cohort's courses. Supported types:
|
|
|
|
| Type | What it measures |
|
|
| --- | --- |
|
|
| **Complete all** | Every selected course is completed |
|
|
| **N of M** | A minimum number of selected courses completed |
|
|
| **Score** | Per-learner score threshold on every selected course |
|
|
| **Pass rate** | Team-wide pass-rate threshold |
|
|
| **Readiness** | No deadline; tracks completion without a due date |
|
|
|
|
Deadlines can be absolute, relative to when the student joins, recurring, or none.
|
|
|
|
## Student experience
|
|
|
|
In the LMS, students open **Cohorts** to see cohorts they belong to. Each cohort hub includes:
|
|
|
|
- **Newsfeed** — updates from instructors
|
|
- **Courses** — linked courses with progress
|
|
- **Goals** — personal goal status when goals are configured
|
|
|
|
:::info
|
|
Legacy deployments may still have data in the original `program` tables. Run the migration script `pnpm --filter @cio/db migrate:programs-to-cohorts` after applying the cohort schema migration to copy existing data into the new tables without dropping the legacy tables.
|
|
:::
|