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]>
52 lines
2.3 KiB
Plaintext
52 lines
2.3 KiB
Plaintext
---
|
|
title: Audience
|
|
description: Manage all students in your organization — view status, assign to courses, and handle invites from one place.
|
|
---
|
|
|
|
**Audience** is your org-wide student directory. It shows every person who belongs to your organization — whether they signed up themselves, accepted a course invite, or were added directly. From here you can search, sort, bulk-assign to courses, and manage pending invites.
|
|
|
|
:::info[Plan limits]
|
|
Your plan sets a maximum audience size. When you reach the limit, a banner appears and you cannot invite more students until you upgrade or remove existing members.
|
|
:::
|
|
|
|
## What Audience shows
|
|
|
|
Audience is separate from course-level **People**. Course People shows who is enrolled in a specific course. Audience shows everyone in your organization regardless of which courses they have joined.
|
|
|
|
| Column | What it means |
|
|
| --- | --- |
|
|
| **Name** | Student's display name |
|
|
| **Email** | Account email address |
|
|
| **Status** | Current membership state (see below) |
|
|
| **Date Joined** | When the student joined the organization |
|
|
|
|
### Status values
|
|
|
|
| Status | Meaning |
|
|
| --- | --- |
|
|
| **Active** | Student has a verified account and is a member of your org |
|
|
| **Pending** | Invite was sent but the student has not yet accepted it |
|
|
| **Expired** | The invite link passed its expiry before the student accepted |
|
|
| **Revoked** | The invite was manually revoked by an admin |
|
|
|
|
## Assign students to courses
|
|
|
|
Select one or more students using the checkboxes, then click **Assign to Courses**. You can pick multiple courses at once. This enrolls the selected students immediately — no action needed from them.
|
|
|
|
## Manage pending invites
|
|
|
|
For students with **Pending** status, you can:
|
|
|
|
- **Resend invite** — sends a fresh invite email to that address
|
|
- **Revoke invite** — cancels the invite so the link no longer works
|
|
|
|
## Import and export
|
|
|
|
Use **Import Users** to bulk-add students from a CSV file. Use **Export** to download the current audience list.
|
|
|
|
## Related guides
|
|
|
|
- [How Course Enrollment Works](/guides/course-enrollment) — how students join courses
|
|
- [How to Invite Students](/guides/invite-students) — send course-specific invites
|
|
- [Roles and Permissions](/guides/roles-and-permissions) — difference between students and team members
|