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>
46 lines
1.7 KiB
Plaintext
46 lines
1.7 KiB
Plaintext
---
|
|
title: Guides
|
|
description: User guides for running your ClassroomIO academy, and developer guides for contributing to the project.
|
|
---
|
|
|
|
These guides cover everything from setup to day-to-day usage, split by who they're for.
|
|
|
|
## User Guides
|
|
|
|
Everything you need to build and run your academy — creating courses and exercises, running live
|
|
classes, enrolling students, publishing your landing pages, and managing your organization and team.
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="What is ClassroomIO" href="/what-is-classroomio" icon="circle-help">
|
|
The platform's key features and capabilities.
|
|
</Card>
|
|
<Card title="Quickstart" href="/quickstart/signup" icon="rocket">
|
|
Sign up and get your organization onboarded.
|
|
</Card>
|
|
<Card title="Create your first course" href="/guides/create-first-course" icon="graduation-cap">
|
|
Build a course end to end, from lessons to publishing.
|
|
</Card>
|
|
<Card title="Terminology" href="/terminology" icon="book-a">
|
|
The words ClassroomIO uses, and what they mean.
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## Developer Guides
|
|
|
|
ClassroomIO is open source and we welcome contributions. These cover getting the project running on
|
|
your machine, the conventions we follow, and the infrastructure behind the platform.
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Contributor guides" href="/guides/contributing" icon="code">
|
|
Start here: local setup, contributing code, design, and translations.
|
|
</Card>
|
|
<Card title="Developers Guide" href="/guides/contributing/devs" icon="terminal">
|
|
Run the monorepo locally: prerequisites, install, and the apps you can start.
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
:::note[Looking to self-host instead?]
|
|
Running ClassroomIO on your own infrastructure is covered separately in
|
|
[Self Hosting](/self-hosted).
|
|
:::
|