chore(docs): migrate the docs site from Fumadocs to Blume (#753)
* 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>
This commit is contained in:
co-authored by
Rotimi Best
parent
5efd7a38c8
commit
b599f1a017
@@ -3,7 +3,7 @@ name: write-docs
|
||||
description: Write accurate, product-grounded documentation pages for ClassroomIO. Use when adding content to stub pages, expanding thin docs, or creating new guide pages under apps/docs/content/docs/.
|
||||
---
|
||||
|
||||
You are writing documentation for ClassroomIO — an LMS platform that lets organizations create and run training academies. Documentation lives in `apps/docs/content/docs/` and is rendered by Fumadocs.
|
||||
You are writing documentation for ClassroomIO — an LMS platform that lets organizations create and run training academies. Documentation lives in `apps/docs/content/docs/` and is rendered by Blume.
|
||||
|
||||
## Research before writing
|
||||
|
||||
@@ -47,15 +47,41 @@ These are the exact sidebar paths in the admin dashboard:
|
||||
|
||||
## MDX format conventions
|
||||
|
||||
All pages use Fumadocs components. Available imports:
|
||||
Pages are rendered by Blume. Its components are global — **do not import anything**.
|
||||
|
||||
**Callouts** are directives, not components. Types: `note`, `info`, `tip`, `success`, `warning`, `danger`.
|
||||
|
||||
```mdx
|
||||
import { Callout } from 'fumadocs-ui/components/callout';
|
||||
import { Step, Steps } from 'fumadocs-ui/components/steps';
|
||||
import { Tab, Tabs } from 'fumadocs-ui/components/tabs';
|
||||
:::warning[Paid plan required]
|
||||
Certificate features require a paid plan.
|
||||
:::
|
||||
```
|
||||
|
||||
**Callout types**: `info`, `warn`, `error`
|
||||
**Steps** for sequential procedures. Keep an `###` heading inside each `<Step>` — it is what
|
||||
generates the linkable anchor:
|
||||
|
||||
```mdx
|
||||
<Steps>
|
||||
<Step>
|
||||
### Enable downloadable certificates
|
||||
|
||||
Turn on **Allow students download certificate**.
|
||||
</Step>
|
||||
</Steps>
|
||||
```
|
||||
|
||||
Also available without imports: `<Tabs>`/`<Tab>`, `<Card>`, `<Accordion>`, `<YouTube id="..." />`,
|
||||
`<CodeGroup>`, `<Frame>`. Code fences take a title: ` ```zsh title="Terminal" `. Mermaid fences render
|
||||
as diagrams.
|
||||
|
||||
**Links and images follow different rules** — this trips people up:
|
||||
|
||||
- **Links**: root-relative, no `/docs` prefix — `[Enrollment](/course-enrollment)`. Blume adds the
|
||||
base at build time.
|
||||
- **Images**: must include the `/docs` prefix — ``. Blume does
|
||||
not rebase images, so an unprefixed path 404s. Files live in `apps/docs/public/`.
|
||||
|
||||
Run `pnpm --filter @cio/docs validate` to check links and anchors.
|
||||
|
||||
**Frontmatter** (required on every page):
|
||||
```mdx
|
||||
@@ -65,6 +91,9 @@ description: One sentence — shown in search results and link previews.
|
||||
---
|
||||
```
|
||||
|
||||
New pages must also be added to the sidebar in `apps/docs/blume.config.ts` (`navigation.sidebar`) —
|
||||
a page that isn't listed there will not appear in the nav.
|
||||
|
||||
## Writing style
|
||||
|
||||
- Address the reader as "you" (the admin/instructor).
|
||||
|
||||
Reference in New Issue
Block a user