From 929c436952c6f0ca8f06c26f3a115f53c1558b0d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sebastian=20D=C3=B6ll?= <sebastian@katallaxie.me>
Date: Thu, 18 Jan 2024 07:29:58 +0000
Subject: [PATCH] docs: update home page

---
 src/pages/index.mdx  | 24 +++++++++++++++++++++++-
 src/theme.config.tsx |  3 ++-
 2 files changed, 25 insertions(+), 2 deletions(-)

diff --git a/src/pages/index.mdx b/src/pages/index.mdx
index 6986a97..5086d14 100644
--- a/src/pages/index.mdx
+++ b/src/pages/index.mdx
@@ -2,4 +2,26 @@
 title: Home
 ---
 
-# Youd docs
+# 👋 Welcome
+
+This is a teeny tiny template for starting a docs project.
+
+## Setup
+
+The template is intended to be used with [Codespaces](https://github.com/features/codespaces) and [GitHub Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).
+
+```bash
+npm i
+```
+
+Get a preview of the docs.
+
+```bash
+npm run dev
+```
+
+Open [localhost:3000](http://localhost:3000)
+
+## Resources
+
+* [Theme Configuration](https://nextra.site/docs/docs-theme/theme-configuration)
diff --git a/src/theme.config.tsx b/src/theme.config.tsx
index 6b3d1a4..1a917fe 100644
--- a/src/theme.config.tsx
+++ b/src/theme.config.tsx
@@ -2,7 +2,8 @@ const config = {
   logo: <span>Docs Template</span>,
   project: {
     link: 'https://github.com/zeiss/docs-template'
-  }
+  },
+  docsRepositoryBase: 'https://github.com/zeiss/docs-template/tree/main'
 }
 
 export default config