diff --git a/pages/features/trail.mdx b/pages/features/trail.mdx index 1dc3fc0..7ab3bd3 100644 --- a/pages/features/trail.mdx +++ b/pages/features/trail.mdx @@ -2,4 +2,10 @@ import { Callout } from 'nextra-theme-docs' import { Card, Cards } from 'nextra-theme-docs' import Image from 'next/image' -# Trail \ No newline at end of file +# Trail + +Trails are a key feature on Learnhouse that enables teachers & students to track their progress through Courses. + +By using Trails, teachers can effectively use quiz results and text-based course progression to tailor feedback in-person & remotely. It also lets students keep a track of their own progression through the course, and encourage increased self-determination & confidence. + + diff --git a/pages/index.mdx b/pages/index.mdx index b436154..bc01316 100644 --- a/pages/index.mdx +++ b/pages/index.mdx @@ -2,21 +2,21 @@ ## What is LearnHouse? -LearnHouse is an open source platform that makes it easy for anyone to provide world class educational content and it offers a variety of content types : Dynamic Pages, Videos, Documents & more.. +LearnHouse is an open source LMS (learning management system) platform that makes it easy for anyone to provide world class educational content. One of the main features is that it offers a variety of content types: Dynamic Pages, Videos, Documents & more..
Hello ## Features -- πŸ“„βœ¨Dynamic notion-like pages -- πŸ‘¨β€πŸŽ“ Easy to use -- πŸ‘₯ Multi-Organization +- πŸ“„βœ¨ Dynamic Notion-like WYSIWYG pages +- πŸ‘¨β€πŸŽ“ Easy & simple to use +- πŸ‘₯ Multi-Organizational - πŸ“Ή Supports Uploadable Videos and external videos like YouTube - πŸ“„ Supports documents like PDF - 🍱 Course Collections -- πŸ™‹ Quizzes -- πŸ‘Ÿ Course progress +- πŸ™‹ Interactive Quizzes +- πŸ‘Ÿ Overall course progress - ⚑ (Incoming) Live Collaboration - More to come diff --git a/pages/self-hosting/_meta.json b/pages/self-hosting/_meta.json index 357b12c..c8255b8 100644 --- a/pages/self-hosting/_meta.json +++ b/pages/self-hosting/_meta.json @@ -3,6 +3,6 @@ "configuration": "Configuration", "organization-hosting-modes": "Organization Hosting Modes", "docker-and-kube": "Docker and Kubernetes", - "vercel": "Using Vercel", + "vercel": "Vercel", "content-storage": "Content Storage" } diff --git a/pages/self-hosting/content-storage/s3.mdx b/pages/self-hosting/content-storage/s3.mdx index 4106fa2..2e36726 100644 --- a/pages/self-hosting/content-storage/s3.mdx +++ b/pages/self-hosting/content-storage/s3.mdx @@ -1,5 +1,7 @@ import { Callout } from 'nextra-theme-docs' +# S3 + We're still working on S3-compatible storage support. - \ No newline at end of file + diff --git a/pages/self-hosting/organization-hosting-modes.mdx b/pages/self-hosting/organization-hosting-modes.mdx index 3a2db81..dab8706 100644 --- a/pages/self-hosting/organization-hosting-modes.mdx +++ b/pages/self-hosting/organization-hosting-modes.mdx @@ -14,7 +14,7 @@ Your Organizations will share the same database and have their content, files, u ## Single Organization setup -Single Organization setup is the default when installing learnhouse for the first time. +Single Organization setup is the default when installing Learnhouse for the first time. When using a Single Organization Setup you should refer your Organization's `slug` in the **frontend config file** @@ -27,6 +27,8 @@ NEXT_PUBLIC_LEARNHOUSE_DEFAULT_ORG=defaultorg ## Multi Organization setup +At the moment, only Single Organizations are supported by Self-Hosting. + ### Frontend Config ```bash filename="apps/web/.env" {1-2} diff --git a/pages/self-hosting/vercel.mdx b/pages/self-hosting/vercel.mdx index 99ffc7b..a6cedb7 100644 --- a/pages/self-hosting/vercel.mdx +++ b/pages/self-hosting/vercel.mdx @@ -1,5 +1,7 @@ -import { Callout } from 'nextra-theme-docs' +import { Callout } from "nextra-theme-docs"; + +# Vercel as Frontend - We're still working on a Vercel guide - \ No newline at end of file + We're still working on a Vercel guide. + diff --git a/pages/self-hosting/vercel.txt b/pages/self-hosting/vercel.txt new file mode 100644 index 0000000..af8c1ed --- /dev/null +++ b/pages/self-hosting/vercel.txt @@ -0,0 +1,33 @@ +import { Callout } from 'nextra-theme-docs' +import { Steps } from 'nextra-theme-docs' + +# Using Vercel as Frontend + + + This is a draft - it should not be published without core team approval. + +
+ + + It's important to note that you can't use Vercel for frontend & backend. Vercel is only hosting the frontend. + + + + +### Deploy to Vercel + +[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Flearnhouse%2Flearnhouse) +Create or log into your Vercel account and clone the repository automatically by clicking on this button. + +### Add Environmental Variables + +In Vercel project settings go to `Settings > Environmental Variables` and paste this .env file into any textbox. + +```env filename="settings/environmental variables" {1-2} +NEXT_PUBLIC_LEARNHOUSE_MULTI_ORG=false +NEXT_PUBLIC_LEARNHOUSE_DEFAULT_ORG=defaultorg +``` + + + You must have a backend to work with the frontend. Vercel will not and can not run the backend of this project. +