feat: migrate docs from Nextra to Fumadocs (#606)

* feat: checkpoint * feat: Migrate docs to Fumadocs * chore: docs layout * chore: - remove home route - make docs home route - remove docs prefix * chore: docs layout * chore: - reorder sidebar - fix home page redirect * chore: rename package to avoid error during pnpm clean * chore: remove private and sideEffects properties from package.json * chore: requested fixes * feat: update fumadocs layout * feat: hide theme switch on sidebar * add /docs * feat: enhance documentation and layout with new guides and updates - Added multiple how-to guides for creating courses, exercises, and managing organization settings. - Updated existing documentation for clarity and consistency, including renaming sections for better navigation. - Introduced new assets such as logos and favicon for improved branding. - Modified layout components to enhance user experience and visual appeal. - Updated package dependencies to include lucide-react for icon usage. * chore: update pnpm-lock.yaml with dependency version changes * add favicon * fix: update links in documentation for consistency - Corrected the links in the create-exercise and signup guides to ensure they point to the correct paths, enhancing clarity and navigation for users. * delete docs --------- Co-authored-by: Rotimi Best <best@classroomio.com>
2025-12-21 13:36:04 +01:00
parent ac1a05f006
commit 2526f4c227
126 changed files with 5808 additions and 1019 deletions
@@ -0,0 +1,118 @@
+import * as React from 'react';
+
+import { HeadContent, Outlet, Scripts, createRootRoute } from '@tanstack/react-router';
+
+import { RootProvider } from 'fumadocs-ui/provider/tanstack';
+import appCss from '@/styles/app.css?url';
+
+export const Route = createRootRoute({
+  head: () => ({
+    meta: [
+      {
+        charSet: 'utf-8'
+      },
+      {
+        name: 'viewport',
+        content: 'width=device-width, initial-scale=1'
+      },
+      {
+        title: 'ClassroomIO | The Open Source Learning Management System for Companies'
+      },
+      {
+        name: 'description',
+        content:
+          'A flexible, user-friendly platform for creating, managing, and delivering courses for companies and training organisations'
+      },
+      {
+        property: 'og:url',
+        content: 'https://classroomio.com/docs'
+      },
+      {
+        property: 'og:type',
+        content: 'website'
+      },
+      {
+        property: 'og:title',
+        content: 'ClassroomIO | The Open Source Learning Management System for Companies'
+      },
+      {
+        property: 'og:description',
+        content:
+          'A flexible, user-friendly platform for creating, managing, and delivering courses for companies and training organisations'
+      },
+      {
+        property: 'og:image:type',
+        content: 'image/png'
+      },
+      {
+        property: 'og:image:width',
+        content: '1920'
+      },
+      {
+        property: 'og:image:height',
+        content: '1080'
+      },
+      {
+        property: 'og:image:secure_url',
+        itemProp: 'image',
+        content: 'https://brand.cdn.clsrio.com/og/classroomio-og.png'
+      },
+      {
+        name: 'twitter:card',
+        content: 'summary_large_image'
+      },
+      {
+        property: 'twitter:domain',
+        content: 'classroomio.com'
+      },
+      {
+        property: 'twitter:url',
+        content: 'https://classroomio.com/docs'
+      },
+      {
+        name: 'twitter:title',
+        content: 'ClassroomIO | The Open Source Learning Management System for Companies'
+      },
+      {
+        name: 'twitter:description',
+        content:
+          'A flexible, user-friendly platform for creating, managing, and delivering courses for companies and training organisations'
+      },
+      {
+        name: 'twitter:creator',
+        content: '@classroomio'
+      },
+      {
+        name: 'twitter:image',
+        content: 'https://brand.cdn.clsrio.com/og/classroomio-og.png'
+      }
+    ],
+    links: [
+      { rel: 'stylesheet', href: appCss },
+      { rel: 'icon', href: '/docs/favicon.ico' }
+    ]
+  }),
+  component: RootComponent
+});
+
+function RootComponent() {
+  return (
+    <RootDocument>
+      <Outlet />
+    </RootDocument>
+  );
+}
+
+function RootDocument({ children }: { children: React.ReactNode }) {
+  return (
+    <html suppressHydrationWarning>
+      <head>
+        <HeadContent />
+      </head>
+      <body className="flex min-h-screen flex-col">
+        <RootProvider>{children}</RootProvider>
+        <Scripts />
+      </body>
+    </html>
+  );
+}