From 364bb2f3340a4407713611f56027f6275512d053 Mon Sep 17 00:00:00 2001
From: Jan-Lukas Else <mail@jlelse.de>
Date: Sun, 26 Sep 2021 13:10:37 +0200
Subject: [PATCH] Structured docs

---
 README.md           | 24 +-----------------------
 docs/_config.yml    |  8 +++++++-
 docs/admin-paths.md | 13 +++++++++++++
 docs/index.md       | 17 +++++++++++++++++
 4 files changed, 38 insertions(+), 24 deletions(-)
 create mode 100644 docs/admin-paths.md
 create mode 100644 docs/index.md

diff --git a/README.md b/README.md
index 4e56be2..93e5d0e 100644
--- a/README.md
+++ b/README.md
@@ -1,25 +1,3 @@
 # GoBlog
 
-Hello!
-
-This repository contains the code for GoBlog, my own blogging system. I created it because I was tired of all the workarounds to customize Hugo and other blog systems to my needs.
-
-The goals of GoBlog are:
-
-- Minimalism
-- Performance
-- Flexibility
-- IndieWeb
-
-To configure GoBlog, take a look at the `example-config.yml` file and save your configuration to `config\config.yml`. How to install and run GoBlog is explained in the [docs](docs/install.md).
-
-Administration paths:
-
-- Login: `/login`
-- Logout: `/logout`
-- Editor: `/editor` (prefixed with the blog path)
-- Notifications: `/notifications`
-- Webmentions: `/webmention`
-- Comments: `/comment`
-
-[jlelse](https://jlelse.blog)
\ No newline at end of file
+How to install and run (and other useful information about) GoBlog is explained in the [docs](https://docs.goblog.app/).
\ No newline at end of file
diff --git a/docs/_config.yml b/docs/_config.yml
index c419263..6d93c19 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -1 +1,7 @@
-theme: jekyll-theme-cayman
\ No newline at end of file
+theme: jekyll-theme-cayman
+
+title: GoBlog
+description: Simple blogging system written in Go
+
+github:
+  is_project_page: false
\ No newline at end of file
diff --git a/docs/admin-paths.md b/docs/admin-paths.md
new file mode 100644
index 0000000..adbebbe
--- /dev/null
+++ b/docs/admin-paths.md
@@ -0,0 +1,13 @@
+# Administration paths
+
+Most settings can be adjusted via the configuration. But to create new posts, log in or out, see notifications or check webmentions there are fixed (partly configurable) paths:
+
+- Login: `/login`
+- Logout: `/logout`
+- Notifications: `/notifications`
+- Webmentions: `/webmention`
+- Comments: `/comment`
+
+Some paths are blog-relative, so they must be appended to the blog path:
+
+- Editor: `/editor`
\ No newline at end of file
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..c6a08ae
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,17 @@
+# GoBlog
+
+With GoBlog [I](https://jlelse.blog) created my own blogging system, because it was too much work for me to implement all my ideas with already existing system. GoBlog is a dynamic blogging system, but inspired by Hugo, it has goals like performance and flexibility. It also implements many IndieWeb functionalities like Webmentions or IndieAuth to use your own blog as an identity on the internet.
+
+License: MIT License
+
+Blog: https://goblog.app/  
+Documentation: https://docs.goblog.app  
+Main repository: https://git.jlel.se/jlelse/GoBlog  
+GitHub mirror: https://github.com/jlelse/GoBlog  
+Codeberg mirror: https://codeberg.org/jlelse/GoBlog
+
+More information about GoBlog:
+
+- [How to install and run GoBlog](./install.md)
+- [How to build GoBlog](./build.md)
+- [Administration paths](./admin-paths.md)
\ No newline at end of file