From 8214ffd63486d1ee21bdbf80c35f9428f22aff03 Mon Sep 17 00:00:00 2001 From: Rotimi Best Date: Wed, 13 Dec 2023 10:16:21 +0300 Subject: [PATCH] fix: blog links --- .../src/lib/Footer/Footer.svelte | 5 ++--- apps/docs/next.config.js | 7 ++++++- apps/docs/pages/_meta.json | 5 +++-- .../_meta.json | 2 +- .../design.mdx | 0 .../devs.mdx | 0 .../gitpod.mdx | 0 .../local-student-dashboard.mdx} | 0 apps/docs/pages/howtoguides/_meta.json | 16 +++++++-------- ...landingpage.mdx => course-landingpage.mdx} | 0 ...createexercise.mdx => create-exercise.mdx} | 0 ...irstcourse.mdx => create-first-course.mdx} | 0 ...ization.mdx => customize-organization.mdx} | 0 .../{gradeexercise.mdx => grade-exercise.mdx} | 0 ...invitestudents.mdx => invite-students.mdx} | 0 ...eteammember.mdx => invite-team-member.mdx} | 0 .../{setupprofile.mdx => setup-profile.mdx} | 0 ...takeattendance.mdx => take-attendance.mdx} | 0 ...entdashboard.mdx => student-dashboard.mdx} | 0 apps/docs/pages/what-is-classroomio.mdx | 20 +++++++++++++++++++ apps/docs/theme.config.tsx | 17 ++++++++++------ 21 files changed, 51 insertions(+), 21 deletions(-) rename apps/docs/pages/{contributorguides => contributor-guides}/_meta.json (62%) rename apps/docs/pages/{contributorguides => contributor-guides}/design.mdx (100%) rename apps/docs/pages/{contributorguides => contributor-guides}/devs.mdx (100%) rename apps/docs/pages/{contributorguides => contributor-guides}/gitpod.mdx (100%) rename apps/docs/pages/{contributorguides/localstudentdashboard.mdx => contributor-guides/local-student-dashboard.mdx} (100%) rename apps/docs/pages/howtoguides/{courselandingpage.mdx => course-landingpage.mdx} (100%) rename apps/docs/pages/howtoguides/{createexercise.mdx => create-exercise.mdx} (100%) rename apps/docs/pages/howtoguides/{createfirstcourse.mdx => create-first-course.mdx} (100%) rename apps/docs/pages/howtoguides/{customizeorganization.mdx => customize-organization.mdx} (100%) rename apps/docs/pages/howtoguides/{gradeexercise.mdx => grade-exercise.mdx} (100%) rename apps/docs/pages/howtoguides/{invitestudents.mdx => invite-students.mdx} (100%) rename apps/docs/pages/howtoguides/{inviteteammember.mdx => invite-team-member.mdx} (100%) rename apps/docs/pages/howtoguides/{setupprofile.mdx => setup-profile.mdx} (100%) rename apps/docs/pages/howtoguides/{takeattendance.mdx => take-attendance.mdx} (100%) rename apps/docs/pages/{studentdashboard.mdx => student-dashboard.mdx} (100%) create mode 100644 apps/docs/pages/what-is-classroomio.mdx diff --git a/apps/classroomio-com/src/lib/Footer/Footer.svelte b/apps/classroomio-com/src/lib/Footer/Footer.svelte index ae97fc0a..3dbd3473 100644 --- a/apps/classroomio-com/src/lib/Footer/Footer.svelte +++ b/apps/classroomio-com/src/lib/Footer/Footer.svelte @@ -1,5 +1,4 @@ @@ -87,7 +86,7 @@
  • - + Getting Started
    • @@ -111,7 +110,7 @@
  • - + Getting Started
    • diff --git a/apps/docs/next.config.js b/apps/docs/next.config.js index d7744cbc..dafa6e04 100644 --- a/apps/docs/next.config.js +++ b/apps/docs/next.config.js @@ -1,9 +1,14 @@ +const env = process.env.NODE_ENV; + const withNextra = require('nextra')({ theme: 'nextra-theme-docs', themeConfig: './theme.config.tsx' }); module.exports = { - basePath: '/docs', + basePath: env === 'production' ? '/docs' : undefined, + env: { + imagePath: env === 'production' ? '/docs' : '' + }, ...withNextra() }; diff --git a/apps/docs/pages/_meta.json b/apps/docs/pages/_meta.json index 9ed53a87..252564fd 100644 --- a/apps/docs/pages/_meta.json +++ b/apps/docs/pages/_meta.json @@ -4,6 +4,7 @@ "title": "Introduction" }, "index": "Welcome", + "what-is-classroomio": "What is ClassroomIO", "quickstart": "Quick Start", "--": { "type": "separator", @@ -11,14 +12,14 @@ }, "organization": "Organization", "course": "Course", - "studentdashboard": "Student Dashboard", + "student-dashboard": "Student Dashboard", "community": "Community", "audience": "Audience", "---": { "type": "separator", "title": "Guides" }, - "contributorguides": "Contributor Guides", + "contributor-guides": "Contributor Guides", "howtoguides": "How To Guides", "contact": { "title": "Contact โ†—", diff --git a/apps/docs/pages/contributorguides/_meta.json b/apps/docs/pages/contributor-guides/_meta.json similarity index 62% rename from apps/docs/pages/contributorguides/_meta.json rename to apps/docs/pages/contributor-guides/_meta.json index b6dc5594..20a807d1 100644 --- a/apps/docs/pages/contributorguides/_meta.json +++ b/apps/docs/pages/contributor-guides/_meta.json @@ -2,5 +2,5 @@ "devs": "Developers Guide", "gitpod": "Gitpod setup", "design": "Designers Guide", - "localstudentdashboard": "Local Student Dashboard" + "local-student-dashboard": "Local Student Dashboard" } \ No newline at end of file diff --git a/apps/docs/pages/contributorguides/design.mdx b/apps/docs/pages/contributor-guides/design.mdx similarity index 100% rename from apps/docs/pages/contributorguides/design.mdx rename to apps/docs/pages/contributor-guides/design.mdx diff --git a/apps/docs/pages/contributorguides/devs.mdx b/apps/docs/pages/contributor-guides/devs.mdx similarity index 100% rename from apps/docs/pages/contributorguides/devs.mdx rename to apps/docs/pages/contributor-guides/devs.mdx diff --git a/apps/docs/pages/contributorguides/gitpod.mdx b/apps/docs/pages/contributor-guides/gitpod.mdx similarity index 100% rename from apps/docs/pages/contributorguides/gitpod.mdx rename to apps/docs/pages/contributor-guides/gitpod.mdx diff --git a/apps/docs/pages/contributorguides/localstudentdashboard.mdx b/apps/docs/pages/contributor-guides/local-student-dashboard.mdx similarity index 100% rename from apps/docs/pages/contributorguides/localstudentdashboard.mdx rename to apps/docs/pages/contributor-guides/local-student-dashboard.mdx diff --git a/apps/docs/pages/howtoguides/_meta.json b/apps/docs/pages/howtoguides/_meta.json index 697f2697..aa10aa6e 100644 --- a/apps/docs/pages/howtoguides/_meta.json +++ b/apps/docs/pages/howtoguides/_meta.json @@ -1,12 +1,12 @@ { "setupprofile": "Setup your Profile", - "customizeorganization": "Customize Organization", - "createfirstcourse": "Create ะกourse", - "createexercise": "Create an Exercise", - "gradeexercise": "Grade an Exercise", - "takeattendance": "Take Attendance", + "customize-organization": "Customize Organization", + "create-first-course": "Create ะกourse", + "create-exercise": "Create an Exercise", + "grade-exercise": "Grade an Exercise", + "take-attendance": "Take Attendance", "certificates": "Create Certificates", - "courselandingpage": "Course Landing Page", - "inviteteammember": "Inviting Team Members", - "invitestudents": "Inviting Students" + "course-landingpage": "Course Landing Page", + "invite-team-member": "Inviting Team Members", + "invite-students": "Inviting Students" } \ No newline at end of file diff --git a/apps/docs/pages/howtoguides/courselandingpage.mdx b/apps/docs/pages/howtoguides/course-landingpage.mdx similarity index 100% rename from apps/docs/pages/howtoguides/courselandingpage.mdx rename to apps/docs/pages/howtoguides/course-landingpage.mdx diff --git a/apps/docs/pages/howtoguides/createexercise.mdx b/apps/docs/pages/howtoguides/create-exercise.mdx similarity index 100% rename from apps/docs/pages/howtoguides/createexercise.mdx rename to apps/docs/pages/howtoguides/create-exercise.mdx diff --git a/apps/docs/pages/howtoguides/createfirstcourse.mdx b/apps/docs/pages/howtoguides/create-first-course.mdx similarity index 100% rename from apps/docs/pages/howtoguides/createfirstcourse.mdx rename to apps/docs/pages/howtoguides/create-first-course.mdx diff --git a/apps/docs/pages/howtoguides/customizeorganization.mdx b/apps/docs/pages/howtoguides/customize-organization.mdx similarity index 100% rename from apps/docs/pages/howtoguides/customizeorganization.mdx rename to apps/docs/pages/howtoguides/customize-organization.mdx diff --git a/apps/docs/pages/howtoguides/gradeexercise.mdx b/apps/docs/pages/howtoguides/grade-exercise.mdx similarity index 100% rename from apps/docs/pages/howtoguides/gradeexercise.mdx rename to apps/docs/pages/howtoguides/grade-exercise.mdx diff --git a/apps/docs/pages/howtoguides/invitestudents.mdx b/apps/docs/pages/howtoguides/invite-students.mdx similarity index 100% rename from apps/docs/pages/howtoguides/invitestudents.mdx rename to apps/docs/pages/howtoguides/invite-students.mdx diff --git a/apps/docs/pages/howtoguides/inviteteammember.mdx b/apps/docs/pages/howtoguides/invite-team-member.mdx similarity index 100% rename from apps/docs/pages/howtoguides/inviteteammember.mdx rename to apps/docs/pages/howtoguides/invite-team-member.mdx diff --git a/apps/docs/pages/howtoguides/setupprofile.mdx b/apps/docs/pages/howtoguides/setup-profile.mdx similarity index 100% rename from apps/docs/pages/howtoguides/setupprofile.mdx rename to apps/docs/pages/howtoguides/setup-profile.mdx diff --git a/apps/docs/pages/howtoguides/takeattendance.mdx b/apps/docs/pages/howtoguides/take-attendance.mdx similarity index 100% rename from apps/docs/pages/howtoguides/takeattendance.mdx rename to apps/docs/pages/howtoguides/take-attendance.mdx diff --git a/apps/docs/pages/studentdashboard.mdx b/apps/docs/pages/student-dashboard.mdx similarity index 100% rename from apps/docs/pages/studentdashboard.mdx rename to apps/docs/pages/student-dashboard.mdx diff --git a/apps/docs/pages/what-is-classroomio.mdx b/apps/docs/pages/what-is-classroomio.mdx new file mode 100644 index 00000000..46bca4a1 --- /dev/null +++ b/apps/docs/pages/what-is-classroomio.mdx @@ -0,0 +1,20 @@ +# What is ClassroomIO + +
    +ClassroomIO Courses page + +ClassroomIO is a platform for bootcamps, individual educators, and training businesses that brings teaching and learning into one place while at the same time helping them be 10x more productive. With our platform, anyone can run multiple classes and cohorts all from one UI. The application is mobile-first, which means that students can access your lesson materials from any device. + +### Mission: Provide Students with the Best Learning Experience + +At ClassroomIO, our mission is to provide students with the best possible learning experience. We believe in empowering educators with the tools they need to deliver high-quality education that is accessible, engaging, and effective. + +### Key Features + +1. **๐Ÿ“š Advanced Course Management:** You can create unlimited courses, create lessons, invite students, add assignments, grade their assignments, and even generate certificates. +2. **๐Ÿ‘จโ€๐Ÿ‘ฉโ€๐Ÿ‘ฆ Multi-Teacher Management:** You can invite other teachers into your organization and assign them individual courses. +3. **๐Ÿค– AI Integration:** We've got OpenAI integration for quick course creation where you can generate course content, lesson outlines, and even generate assignments right from your lesson notes. +4. **๐Ÿ’ฌ Forum:** Students can ask questions in your dedicated community and get answers from either you or other students. +5. **๐Ÿ† Kahoot-Like Quiz:** You can create live quizzes to create more engagement in your classrooms. +6. **๐Ÿ’ป Dedicated Student Dashboard:** Once you create an account, you get a dedicated dashboard where your students can access all their courses, assignments, and more. +7. **๐Ÿ”’ Fully open source:** You can self-host the entire stack on your servers. diff --git a/apps/docs/theme.config.tsx b/apps/docs/theme.config.tsx index a1497ddf..a02820bf 100644 --- a/apps/docs/theme.config.tsx +++ b/apps/docs/theme.config.tsx @@ -4,7 +4,12 @@ import { DocsThemeConfig } from 'nextra-theme-docs'; const config: DocsThemeConfig = { logo: (
    - {'ClassroomIO + {'ClassroomIO ClassroomIO Docs
    ), @@ -21,34 +26,34 @@ const config: DocsThemeConfig = { 'Spend less time doing the boring stuff, instead focus on impacting the lives of your students.', images: [ { - url: '/docs/img/logo-16.png', + url: `${process.env.imagePath}/img/logo-16.png`, width: 16, height: 16, alt: 'ClassroomIO Docs Og Image Alt', type: 'image/png' }, { - url: '/docs/img/logo-32.png', + url: `${process.env.imagePath}/img/logo-32.png`, width: 32, height: 32, alt: 'ClassroomIO Docs Og Image Alt', type: 'image/png' }, { - url: '/docs/img/logo-192.png', + url: `${process.env.imagePath}/img/logo-192.png`, width: 192, height: 192, alt: 'ClassroomIO Docs Og Image Alt', type: 'image/png' }, { - url: '/docs/img/logo-512.png', + url: `${process.env.imagePath}/img/logo-512.png`, width: 512, height: 512, alt: 'ClassroomIO Docs Og Image Alt', type: 'image/png' }, - { url: '/docs/img/og-image.png' } + { url: `${process.env.imagePath}/img/og-image.png'` } ], twitter: { handle: '@classroomio',