feat: setup documentation structure (#61)

2023-11-30 15:23:11 +03:00
parent e815c93354
commit e4cc31a17c
23 changed files with 256 additions and 70 deletions
@@ -1,11 +1,35 @@
 {
-  "index": "Introduction",
-  "what-is-classroomio": "What is ClassroomIO?",
-  "getting-started": "Getting Started",
+  "-": {
+    "type": "separator",
+    "title": "Introduction"
+  },
+  "index": "Welcome",
+  "quickstart": "Quick Start",
+  "--": {
+    "type": "separator",
+    "title": "Core Features"
+  },
+  "organization": "Organization",
+  "course": "Course",
+  "studentdashboard": "Student Dashboard",
+  "community": "Community",
+  "audience": "Audience",
+  "---": {
+    "type": "separator",
+    "title": "Guides"
+  },
+  "contributorguides": "Contributor Guides",
+  "howtoguides": "How To Guides",
  "contact": {
    "title": "Contact ↗",
    "type": "page",
    "href": "https://twitter.com/classroomio",
    "newWindow": true
+  },
+  "demo": {
+    "title": "Demo ↗",
+    "type": "page",
+    "href": "https://dub.sh/ciodemo",
+    "newWindow": true
  }
 }
@@ -1,3 +0,0 @@
-# About
-
-This is the about page! This page is shown on the navbar.
@@ -0,0 +1,7 @@
+import { Callout } from "nextra/components";
+
+# Audience
+
+<Callout emoji='🚨'>
+	This page is a work in progress. Help us expand it by contributing!
+</Callout>
@@ -0,0 +1,7 @@
+import { Callout } from "nextra/components";
+
+# Community
+
+<Callout emoji='🚨'>
+	This page is a work in progress. Help us expand it by contributing!
+</Callout>
@@ -0,0 +1,5 @@
+{
+  "devs": "Developers Contribution Guide",
+  "design": "Design Contribution Guide",
+  "localstudentdashboard": "Local Student Dashboard"
+}
@@ -0,0 +1,7 @@
+import { Callout } from "nextra/components";
+
+# Design Contribution Guide
+
+<Callout emoji='🚨'>
+	This page is a work in progress. Help us expand it by contributing!
+</Callout>
@@ -0,0 +1,7 @@
+import { Callout } from "nextra/components";
+
+# Developers Contribution Guide
+
+<Callout emoji='🚨'>
+	This page is a work in progress. Help us expand it by contributing!
+</Callout>
@@ -0,0 +1,7 @@
+import { Callout } from "nextra/components";
+
+# Local Student Dashboard
+
+<Callout emoji='🚨'>
+	This page is a work in progress. Help us expand it by contributing!
+</Callout>
@@ -0,0 +1,7 @@
+import { Callout } from "nextra/components";
+
+# Course
+
+<Callout emoji='🚨'>
+	This page is a work in progress. Help us expand it by contributing!
+</Callout>
@@ -1,3 +0,0 @@
-# Getting Started
-
-Getting started with ClassroomIO
@@ -0,0 +1,5 @@
+{
+  "createfirstcourse": "Creating your first course",
+  "inviteteammember": "Inviting Team Members",
+  "customizeorganization": "Customize your Organization"
+}
@@ -0,0 +1,12 @@
+# Create your first Course
+
+Below is a video that will walk you through the process of creating your first course. If you have any questions
+
+<iframe
+	width='560'
+	height='315'
+	src='https://www.youtube.com/embed/ztiZ6vo2gg0?si=v_UUL1YUPyDQ4_pp'
+	title='YouTube video player'
+	frameborder='0'
+	allow='accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share'
+	allowfullscreen></iframe>
@@ -0,0 +1,7 @@
+import { Callout } from "nextra/components";
+
+# Customize your Organization
+
+<Callout emoji='🚨'>
+	This page is a work in progress. Help us expand it by contributing!
+</Callout>
@@ -0,0 +1,7 @@
+import { Callout } from "nextra/components";
+
+# Inviting a Team Member
+
+<Callout emoji='🚨'>
+	This page is a work in progress. Help us expand it by contributing!
+</Callout>
@@ -1,3 +1,11 @@
-# Introduction
- 
-Welcome to ClassroomIO
+# The ClassroomIO Documentation
+
+<br />
+<img
+	alt='Spend less time on the boring stuff, and instead focus on impacting the lives of your students.'
+	src='https://classroomio.com/classroomio-opengraph-image.png'
+/>
+
+This is the documentation for ClassroomIO, a platform for bootcamps, individual educators, and training businesses to bring teaching and learning into one place while at the same time helping them be 10x more productive. Anyone can run multiple classes and cohorts all from one UI, the application is mobile-first, which means that students can access all published content from any device.
+
+It covers everything from setup to usage. You'd find a well detailed explanation of the core features ClassroomIO offers and how to take advantage of them. Developers and Designers can find everything they need to successfully contribute to the project. For more practical usage, we've got a ton of guides ranging from simple functionalities to more complex ones. If there is something we don't cover in this documentation, please feel free to open an issue and we can pick it up from there.
@@ -0,0 +1,7 @@
+import { Callout } from "nextra/components";
+
+# Organization
+
+<Callout emoji='🚨'>
+	This page is a work in progress. Help us expand it by contributing!
+</Callout>
@@ -0,0 +1,5 @@
+{
+  "signup": "Signup",
+  "onboarding": "Onboarding",
+  "selfhosting": "Self-hosting"
+}
@@ -0,0 +1,9 @@
+# Onboarding
+
+Welcome again to ClassroomIO and we are super excited you are giving it a try. On this page you will find your onboarding checklist, the first thing you need to do after you've created an account.
+
+1. Set your profile picture
+2. Set your organization details
+3. Customize your organization landing page
+4. Create your first course
+5. Share your course with students
@@ -0,0 +1,7 @@
+import { Callout } from "nextra/components";
+
+# Self hosting
+
+<Callout emoji='🚨'>
+	This page is a work in progress. Help us expand it by contributing!
+</Callout>
@@ -0,0 +1,46 @@
+import { Steps, Callout } from "nextra/components";
+
+# Signing Up for ClassroomIO
+
+Signing up is currently disabled on production. Potential customers can only book a demo or try out our local setup.
+
+## Signing up locally.
+
+This assumption of this section is that you already have ClassroomIO setup locally.
+
+To sign up do the following.
+
+<Steps>
+### Start the application locally
+
+To get the application running locally, you should run this at the root of the project:
+
+```js
+pnpm dev --filter=dashboard
+```
+
+This will only startup the dashboard which powers all of the learning management features.
+
+<Callout
+	type='info'
+	emoji='ℹ️'>
+	Note: Make sure you have installed all dependencies by running `pnpm i`
+</Callout>
+
+### Go to Sign up page
+
+Once you startup the `dashboard`, you can open your browser and go to `http://localhost:5173`. Click on the signup button to take you to the Sign up page.
+
+### Create an account
+
+Once you are on the signup page, enter your email and a password made up of 6 or more characters
+
+### Complete the onboarding
+
+Upon completing the signup flow, you will be redirected to the onboarding page. Here you can enter your fullname and your organization details and next you would share how you heard of ClassroomIO
+
+### Welcome to the dashboard
+
+After you go through the onboarding, you are successfully signed up and you are ready to start using the platform.
+
+</Steps>
@@ -0,0 +1,7 @@
+import { Callout } from "nextra/components";
+
+# Student Dashboard
+
+<Callout emoji='🚨'>
+	This page is a work in progress. Help us expand it by contributing!
+</Callout>
@@ -1,3 +0,0 @@
-# What is ClassroomIO
- 
-Here will be more details about ClassroomIO
@@ -1,58 +1,62 @@
-import React from 'react'
-import { DocsThemeConfig } from 'nextra-theme-docs'
+import React from "react";
+import { DocsThemeConfig } from "nextra-theme-docs";

 const config: DocsThemeConfig = {
-  logo: (
-    <div style={{ display: 'flex', alignItems: 'center' }}>
-      <img
-        src={`/img/logo-512.png`}
-        alt={"ClassroomIO logo"}
-        width={32}
-        height={32}
-      />
-      <span style={{ marginLeft: '5px', lineHeight: '15px' }}>ClassroomIO Help Docs</span>
-    </div>
-  ),
-  project: {
-    link: 'https://github.com/classroomio/docs',
-  },
-  useNextSeoProps() {
-    return {
-      titleTemplate: "ClassroomIO Help Docs",
-      openGraph: {
-        images: [{ url: `/img/og-image.png` }],
-        siteName: "ClassroomIO Help Docs",
-      },
-    };
-  },
-  chat: {
-    link: 'https://discord.com',
-  },
-  docsRepositoryBase: 'https://github.com/classroomio/docs',
-  footer: {
-    text: 'ClassroomIO Help Docs',
-  },
-  head: (
-    <>
-      <link
-        rel="shortcut icon"
-        type="image/x-icon"
-        href={`/img/favicon.ico`}
-      />
-      <link
-        rel="icon"
-        type="image/x-icon"
-        sizes="16x16"
-        href={`/img/logo-16.png`}
-      />
-      <link
-        rel="icon"
-        type="image/x-icon"
-        sizes="32x32"
-        href={`/img/logo-32.png`}
-      />
-    </>
-  ),
-}
+	logo: (
+		<div style={{ display: "flex", alignItems: "center" }}>
+			<img
+				src={`/img/logo-512.png`}
+				alt={"ClassroomIO logo"}
+				width={32}
+				height={32}
+			/>
+			<span style={{ marginLeft: "5px", lineHeight: "15px" }}>ClassroomIO Docs</span>
+		</div>
+	),
+	project: {
+		link: "https://github.com/rotimi-best/classroomio",
+	},
+	useNextSeoProps() {
+		return {
+			titleTemplate: "ClassroomIO Documentation",
+			openGraph: {
+				images: [{ url: `/img/og-image.png` }],
+				siteName: "ClassroomIO Documentation",
+			},
+		};
+	},
+	chat: {
+		link: "https://dub.sh/ciodiscord",
+	},
+	sidebar: {
+		defaultMenuCollapseLevel: 1,
+		autoCollapse: false,
+	},
+	docsRepositoryBase: "https://github.com/rotimi-best/classroomio/apps/docs",
+	footer: {
+		text: "ClassroomIO Help Docs",
+	},
+	head: (
+		<>
+			<link
+				rel='shortcut icon'
+				type='image/x-icon'
+				href={`/img/favicon.ico`}
+			/>
+			<link
+				rel='icon'
+				type='image/x-icon'
+				sizes='16x16'
+				href={`/img/logo-16.png`}
+			/>
+			<link
+				rel='icon'
+				type='image/x-icon'
+				sizes='32x32'
+				href={`/img/logo-32.png`}
+			/>
+		</>
+	),
+};

-export default config
+export default config;