feat: reorganize docs & upgrade deps

This commit is contained in:
swve
2023-08-21 19:55:08 +02:00
parent a4cb11f39e
commit d1fe37e751
8 changed files with 938 additions and 101 deletions

1000
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -11,10 +11,10 @@
"dependencies": {
"@react-aria/ssr": "^3.6.0",
"@vercel/analytics": "^1.0.1",
"next": "^13.4.13",
"next": "^13.4.19",
"next-sitemap": "^4.1.8",
"nextra": "^2.5.2",
"nextra-theme-docs": "^2.5.2",
"nextra": "^2.11.1",
"nextra-theme-docs": "^2.11.1",
"react": "^18.2.0",
"react-dom": "^18.2.0"
},

View File

@@ -1,19 +1,16 @@
{
"-- Overview": {
"type": "separator",
"title": "Overview"
},
"index": "Introduction",
"-- General": {
"type": "separator",
"title": "General"
},
"features": "Features",
"-- Technical": {
"-- Developers": {
"type": "separator",
"title": "Technical"
"title": "Developers"
},
"overview": "Overview",
"self-hosting": "Self Hosting",
"-- Contribute": {
"type": "separator",
"title": "Contribute"
},
"setup-dev-environment": "Set up a dev environment"
"setup-dev-environment": "Quick Start",
"concepts": "Concepts",
"self-hosting": "Self Hosting"
}

View File

@@ -1,7 +1,7 @@
import { Callout } from "nextra-theme-docs";
import { Steps } from "nextra-theme-docs";
# Setting a dev environment
# Setting up a dev environment
This is a guide to set up a dev environment for LearnHouse, it will guide you through the installation of the backend and the frontend.
@@ -70,7 +70,7 @@ npm i
```
Add an .env file in the front folder with the following content
```env filename="front/.env.local" {1-2}
```env filename="front/.env" {1-2}
NEXT_PUBLIC_LEARNHOUSE_MULTI_ORG=false
NEXT_PUBLIC_LEARNHOUSE_DEFAULT_ORG=test
NEXT_PUBLIC_LEARNHOUSE_API_URL=http://localhost:1338/api/v1/
@@ -114,7 +114,7 @@ Create your Organization, Account and roles.
You'll need to update the front env file to set your Organization as the default one, use the **slug** of your organization.
```env filename="front/.env.local" {2}
```env filename="front/.env" {2}
NEXT_PUBLIC_LEARNHOUSE_MULTI_ORG=false
NEXT_PUBLIC_LEARNHOUSE_DEFAULT_ORG=REPLACE_WITH_YOUR_ORG_SLUG
NEXT_PUBLIC_LEARNHOUSE_API_URL=http://localhost:1338/api/v1/

View File

@@ -25,14 +25,14 @@ export default {
text: <span>{new Date().getFullYear()} © LearnHouse.</span>,
},
sidebar: {
defaultMenuCollapseLevel: 1,
defaultMenuCollapseLevel: 2,
},
useNextSeoProps() {
return {
titleTemplate: "%s LearnHouse Docs",
canonical: "https://docs.learnhouse.app",
description: "The next-gen open source learning software",
openGraph: {
type: "website",
locale: "en_US",