Skip to content

Commit

Permalink
feat: docs updates
Browse files Browse the repository at this point in the history
  • Loading branch information
joelhooks committed Nov 22, 2023
1 parent c54ef9c commit 9e40f13
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 15 deletions.
9 changes: 4 additions & 5 deletions docs/src/content/docs/Guides/publishing-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ title: Publishing Content
description: Basic CRUD
---

Course Builder works as a simple content management system that is built "in
front of" [Sanity](https://sanity.io). Sanity is a headless, full-feature,
brilliant CMS that Course Builder uses as a content database and lower level
content management system to use as needed.
Course Builder works as a simple content management system that is built "in front of" [Sanity](https://sanity.io).
Sanity is a headless, full-feature, brilliant CMS that Course Builder uses as a content database and lower level content
management system to use as needed.

## Types of Content

Expand All @@ -24,4 +23,4 @@ content management system to use as needed.

## Updating Content

## Removing Content
## Removing Content
1 change: 0 additions & 1 deletion docs/src/content/docs/Under the Hood/content-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@ title: Content Management
## Sanity

### Sanity Schemas

2 changes: 1 addition & 1 deletion docs/src/content/docs/Under the Hood/deployment.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
title: Deployment
---
---
12 changes: 4 additions & 8 deletions docs/src/content/docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
---
title: ⭐ Getting Started
description: This will help you create a new Course Builder project.
sidebar:
order: 0
sidebar:
order: 0
---

Course Builder is a Turborepo project that includes the website, this docs site you are reading right now, and the
various libraries and packages that represent the Course Builder platform.

:::note
This guide is a work in progress. It will be updated as the project evolves.
:::
:::note This guide is a work in progress. It will be updated as the project evolves. :::

It's non-trivial and these guides are going to make several assumptions:

Expand Down Expand Up @@ -83,9 +81,7 @@ cp .env.example .env

They are all required.

:::note
There are 3 (THREE!) different entries for the URL of the project in the environment
:::
:::note There are 3 (THREE!) different entries for the URL of the project in the environment :::

```dotenv
NEXTAUTH_URL="YOUR_TUNNEL.ngrok-free.app/"
Expand Down

1 comment on commit 9e40f13

@vercel
Copy link

@vercel vercel bot commented on 9e40f13 Nov 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.