Skip to content

Commit 229bcde

Browse files
committed
chore: enhance docs
1 parent efaff6d commit 229bcde

File tree

3 files changed

+10
-13
lines changed

3 files changed

+10
-13
lines changed

.changeset/README.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,13 @@
33
To set up the course template, follow these steps:
44

55
1. Use repository as a template
6-
1. Clone the repository
6+
1. Clone the repository to your local machine
77
1. Open the repository in a code editor
8-
1. Reopen inside the dev container
9-
1. Enable GitHub Actions
10-
1. Enable GitHub Pages
8+
- Reopen inside the dev container
9+
1. Replace placeholder values in the files
10+
1. Apply the following settings on Github:
11+
- Enable GitHub Actions
12+
- Enable GitHub Pages
13+
- Enable `Allow GitHub Actions to create and approve pull requests` in Settings > Actions > General
14+
- Add a Ruleset for the `changeset-release/main` to allow force pushes
15+
- Allow `changeset-release/main` to use the `github-pages` Environment in Settings > Environments

apps/docs/src/content/docs/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ hero:
1111
link: ./org/schedule/
1212
icon: right-arrow
1313
- text: Präsentation
14-
link: ./org/presentation/
14+
link: ./slides/
1515
icon: document
1616
variant: minimal
1717
---

0 commit comments

Comments
 (0)