From e4cc31a17c5724a3206de81f12630c718fd710a1 Mon Sep 17 00:00:00 2001 From: Rotimi Best Date: Thu, 30 Nov 2023 15:23:11 +0300 Subject: [PATCH] feat: setup documentation structure (#61) --- apps/docs/pages/_meta.json | 30 ++++- apps/docs/pages/about.mdx | 3 - apps/docs/pages/audience.mdx | 7 ++ apps/docs/pages/community.mdx | 7 ++ apps/docs/pages/contributorguides/_meta.json | 5 + apps/docs/pages/contributorguides/design.mdx | 7 ++ apps/docs/pages/contributorguides/devs.mdx | 7 ++ .../localstudentdashboard.mdx | 7 ++ apps/docs/pages/course.mdx | 7 ++ apps/docs/pages/getting-started.mdx | 3 - apps/docs/pages/howtoguides/_meta.json | 5 + .../pages/howtoguides/createfirstcourse.mdx | 12 ++ .../howtoguides/customizeorganization.mdx | 7 ++ .../pages/howtoguides/inviteteammember.mdx | 7 ++ apps/docs/pages/index.mdx | 14 ++- apps/docs/pages/organization.mdx | 7 ++ apps/docs/pages/quickstart/_meta.json | 5 + apps/docs/pages/quickstart/onboarding.mdx | 9 ++ apps/docs/pages/quickstart/selfhosting.mdx | 7 ++ apps/docs/pages/quickstart/signup.mdx | 46 +++++++ apps/docs/pages/studentdashboard.mdx | 7 ++ apps/docs/pages/what-is-classroomio.mdx | 3 - apps/docs/theme.config.tsx | 114 +++++++++--------- 23 files changed, 256 insertions(+), 70 deletions(-) delete mode 100644 apps/docs/pages/about.mdx create mode 100644 apps/docs/pages/audience.mdx create mode 100644 apps/docs/pages/community.mdx create mode 100644 apps/docs/pages/contributorguides/_meta.json create mode 100644 apps/docs/pages/contributorguides/design.mdx create mode 100644 apps/docs/pages/contributorguides/devs.mdx create mode 100644 apps/docs/pages/contributorguides/localstudentdashboard.mdx create mode 100644 apps/docs/pages/course.mdx delete mode 100644 apps/docs/pages/getting-started.mdx create mode 100644 apps/docs/pages/howtoguides/_meta.json create mode 100644 apps/docs/pages/howtoguides/createfirstcourse.mdx create mode 100644 apps/docs/pages/howtoguides/customizeorganization.mdx create mode 100644 apps/docs/pages/howtoguides/inviteteammember.mdx create mode 100644 apps/docs/pages/organization.mdx create mode 100644 apps/docs/pages/quickstart/_meta.json create mode 100644 apps/docs/pages/quickstart/onboarding.mdx create mode 100644 apps/docs/pages/quickstart/selfhosting.mdx create mode 100644 apps/docs/pages/quickstart/signup.mdx create mode 100644 apps/docs/pages/studentdashboard.mdx delete mode 100644 apps/docs/pages/what-is-classroomio.mdx diff --git a/apps/docs/pages/_meta.json b/apps/docs/pages/_meta.json index b2b7bb35..9ed53a87 100644 --- a/apps/docs/pages/_meta.json +++ b/apps/docs/pages/_meta.json @@ -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 } } diff --git a/apps/docs/pages/about.mdx b/apps/docs/pages/about.mdx deleted file mode 100644 index ec6faed8..00000000 --- a/apps/docs/pages/about.mdx +++ /dev/null @@ -1,3 +0,0 @@ -# About - -This is the about page! This page is shown on the navbar. diff --git a/apps/docs/pages/audience.mdx b/apps/docs/pages/audience.mdx new file mode 100644 index 00000000..321fe32a --- /dev/null +++ b/apps/docs/pages/audience.mdx @@ -0,0 +1,7 @@ +import { Callout } from "nextra/components"; + +# Audience + + + This page is a work in progress. Help us expand it by contributing! + diff --git a/apps/docs/pages/community.mdx b/apps/docs/pages/community.mdx new file mode 100644 index 00000000..be4db170 --- /dev/null +++ b/apps/docs/pages/community.mdx @@ -0,0 +1,7 @@ +import { Callout } from "nextra/components"; + +# Community + + + This page is a work in progress. Help us expand it by contributing! + diff --git a/apps/docs/pages/contributorguides/_meta.json b/apps/docs/pages/contributorguides/_meta.json new file mode 100644 index 00000000..5d95557d --- /dev/null +++ b/apps/docs/pages/contributorguides/_meta.json @@ -0,0 +1,5 @@ +{ + "devs": "Developers Contribution Guide", + "design": "Design Contribution Guide", + "localstudentdashboard": "Local Student Dashboard" +} \ No newline at end of file diff --git a/apps/docs/pages/contributorguides/design.mdx b/apps/docs/pages/contributorguides/design.mdx new file mode 100644 index 00000000..2fa6246b --- /dev/null +++ b/apps/docs/pages/contributorguides/design.mdx @@ -0,0 +1,7 @@ +import { Callout } from "nextra/components"; + +# Design Contribution Guide + + + This page is a work in progress. Help us expand it by contributing! + diff --git a/apps/docs/pages/contributorguides/devs.mdx b/apps/docs/pages/contributorguides/devs.mdx new file mode 100644 index 00000000..4071a918 --- /dev/null +++ b/apps/docs/pages/contributorguides/devs.mdx @@ -0,0 +1,7 @@ +import { Callout } from "nextra/components"; + +# Developers Contribution Guide + + + This page is a work in progress. Help us expand it by contributing! + diff --git a/apps/docs/pages/contributorguides/localstudentdashboard.mdx b/apps/docs/pages/contributorguides/localstudentdashboard.mdx new file mode 100644 index 00000000..0c03a941 --- /dev/null +++ b/apps/docs/pages/contributorguides/localstudentdashboard.mdx @@ -0,0 +1,7 @@ +import { Callout } from "nextra/components"; + +# Local Student Dashboard + + + This page is a work in progress. Help us expand it by contributing! + diff --git a/apps/docs/pages/course.mdx b/apps/docs/pages/course.mdx new file mode 100644 index 00000000..ae71c374 --- /dev/null +++ b/apps/docs/pages/course.mdx @@ -0,0 +1,7 @@ +import { Callout } from "nextra/components"; + +# Course + + + This page is a work in progress. Help us expand it by contributing! + diff --git a/apps/docs/pages/getting-started.mdx b/apps/docs/pages/getting-started.mdx deleted file mode 100644 index 1c92620e..00000000 --- a/apps/docs/pages/getting-started.mdx +++ /dev/null @@ -1,3 +0,0 @@ -# Getting Started - -Getting started with ClassroomIO diff --git a/apps/docs/pages/howtoguides/_meta.json b/apps/docs/pages/howtoguides/_meta.json new file mode 100644 index 00000000..7db45457 --- /dev/null +++ b/apps/docs/pages/howtoguides/_meta.json @@ -0,0 +1,5 @@ +{ + "createfirstcourse": "Creating your first course", + "inviteteammember": "Inviting Team Members", + "customizeorganization": "Customize your Organization" +} \ No newline at end of file diff --git a/apps/docs/pages/howtoguides/createfirstcourse.mdx b/apps/docs/pages/howtoguides/createfirstcourse.mdx new file mode 100644 index 00000000..0fd4c60e --- /dev/null +++ b/apps/docs/pages/howtoguides/createfirstcourse.mdx @@ -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 + + diff --git a/apps/docs/pages/howtoguides/customizeorganization.mdx b/apps/docs/pages/howtoguides/customizeorganization.mdx new file mode 100644 index 00000000..548cf940 --- /dev/null +++ b/apps/docs/pages/howtoguides/customizeorganization.mdx @@ -0,0 +1,7 @@ +import { Callout } from "nextra/components"; + +# Customize your Organization + + + This page is a work in progress. Help us expand it by contributing! + diff --git a/apps/docs/pages/howtoguides/inviteteammember.mdx b/apps/docs/pages/howtoguides/inviteteammember.mdx new file mode 100644 index 00000000..cfcf4714 --- /dev/null +++ b/apps/docs/pages/howtoguides/inviteteammember.mdx @@ -0,0 +1,7 @@ +import { Callout } from "nextra/components"; + +# Inviting a Team Member + + + This page is a work in progress. Help us expand it by contributing! + diff --git a/apps/docs/pages/index.mdx b/apps/docs/pages/index.mdx index 88a214c8..bdf4dd14 100644 --- a/apps/docs/pages/index.mdx +++ b/apps/docs/pages/index.mdx @@ -1,3 +1,11 @@ -# Introduction - -Welcome to ClassroomIO +# The ClassroomIO Documentation + +
+Spend less time on the boring stuff, and instead focus on impacting the lives of your students. + +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. diff --git a/apps/docs/pages/organization.mdx b/apps/docs/pages/organization.mdx new file mode 100644 index 00000000..26b87934 --- /dev/null +++ b/apps/docs/pages/organization.mdx @@ -0,0 +1,7 @@ +import { Callout } from "nextra/components"; + +# Organization + + + This page is a work in progress. Help us expand it by contributing! + diff --git a/apps/docs/pages/quickstart/_meta.json b/apps/docs/pages/quickstart/_meta.json new file mode 100644 index 00000000..46574660 --- /dev/null +++ b/apps/docs/pages/quickstart/_meta.json @@ -0,0 +1,5 @@ +{ + "signup": "Signup", + "onboarding": "Onboarding", + "selfhosting": "Self-hosting" +} \ No newline at end of file diff --git a/apps/docs/pages/quickstart/onboarding.mdx b/apps/docs/pages/quickstart/onboarding.mdx new file mode 100644 index 00000000..c22d9abc --- /dev/null +++ b/apps/docs/pages/quickstart/onboarding.mdx @@ -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 diff --git a/apps/docs/pages/quickstart/selfhosting.mdx b/apps/docs/pages/quickstart/selfhosting.mdx new file mode 100644 index 00000000..2e187e46 --- /dev/null +++ b/apps/docs/pages/quickstart/selfhosting.mdx @@ -0,0 +1,7 @@ +import { Callout } from "nextra/components"; + +# Self hosting + + + This page is a work in progress. Help us expand it by contributing! + diff --git a/apps/docs/pages/quickstart/signup.mdx b/apps/docs/pages/quickstart/signup.mdx new file mode 100644 index 00000000..a2388d42 --- /dev/null +++ b/apps/docs/pages/quickstart/signup.mdx @@ -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. + + +### 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. + + + Note: Make sure you have installed all dependencies by running `pnpm i` + + +### 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. + + diff --git a/apps/docs/pages/studentdashboard.mdx b/apps/docs/pages/studentdashboard.mdx new file mode 100644 index 00000000..a7ffc177 --- /dev/null +++ b/apps/docs/pages/studentdashboard.mdx @@ -0,0 +1,7 @@ +import { Callout } from "nextra/components"; + +# Student Dashboard + + + This page is a work in progress. Help us expand it by contributing! + diff --git a/apps/docs/pages/what-is-classroomio.mdx b/apps/docs/pages/what-is-classroomio.mdx deleted file mode 100644 index 17347830..00000000 --- a/apps/docs/pages/what-is-classroomio.mdx +++ /dev/null @@ -1,3 +0,0 @@ -# What is ClassroomIO - -Here will be more details about ClassroomIO diff --git a/apps/docs/theme.config.tsx b/apps/docs/theme.config.tsx index 18cc9c4d..a7ccb896 100644 --- a/apps/docs/theme.config.tsx +++ b/apps/docs/theme.config.tsx @@ -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: ( -
- {"ClassroomIO - ClassroomIO Help Docs -
- ), - 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: ( - <> - - - - - ), -} + logo: ( +
+ {"ClassroomIO + ClassroomIO Docs +
+ ), + 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: ( + <> + + + + + ), +}; -export default config +export default config;