From 86e72534fc879e37585489dd010523ed34249876 Mon Sep 17 00:00:00 2001 From: ibizaman Date: Tue, 19 Dec 2023 22:40:22 -0800 Subject: [PATCH] improve the manual preface --- docs/preface.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/docs/preface.md b/docs/preface.md index e95a099..3300e45 100644 --- a/docs/preface.md +++ b/docs/preface.md @@ -1,12 +1,25 @@ # Preface {#preface} ::: {.note} -This document is the complete manual for Self Host Blocks, the building blocks for self-hosting with battery included. -::: - Self Host Blocks is hosted on [GitHub](https://github.com/ibizaman/selfhostblocks). If you encounter problems or bugs then please report them on the [issue tracker](https://github.com/ibizaman/selfhostblocks/issues). Feel free to join the dedicated Matrix room [matrix.org#selfhostblocks](https://matrix.to/#/#selfhostblocks:matrix.org). +::: + +Self Host Blocks intends to help you self host any service you would like with best practices out of +the box. + +To achieve this, Self Host Blocks provides building blocks which each provide part of what a self +hosted app should do (SSO, HTTPS, etc.). It also provides some services that are already integrated +with all those building blocks. + +- You are new to self hosting and want pre-configured services to deploy easily. Look at the + [services section](services.html). +- You are a seasoned self-hoster but want to enhance some services you deploy already. Go to the + [blocks section](blocks.html). +- You are a user of Self Host Blocks but would like to use your own implementation for a block. Head + over to the [matrix channel](https://matrix.to/#/#selfhostblocks:matrix.org) (the manual for this + is WIP).