pleroma-fe

commit: 7bd89b579f9fa20a046b67dbf5cd14967b07981c
parent: e1cf6bd41ced8f1d85dde6ba557ca6ea28bd6028
Author: lain <lain@soykaf.club>
Date:   Fri,  3 Jul 2020 10:17:42 +0000

Merge branch 'fix_BE_1586_provide_index_md' into 'develop'

FE part of BE issue 1586 provide index md

See merge request pleroma/pleroma-fe!1154
Diffstat:
M
docs/USER_GUIDE.md
2
--
A
docs/index.md
8
++++++++

2 files changed, 8 insertions(+), 2 deletions(-)
diff --git a/docs/USER_GUIDE.md b/docs/USER_GUIDE.md
@@ -8,8 +8,6 @@
 >
 > --Catbag
 
-Pleroma-FE user interface is modeled after Qvitter which is modeled after older Twitter design. It provides a simple 2-column interface for microblogging. While being simple by default it also provides many powerful customization options.
-
 ## Posting, reading, basic functions.
 
 After registering and logging in you're presented with your timeline in right column and new post form with timeline list and notifications in the left column.
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,8 @@
+# Introduction to Pleroma-FE
+## What is Pleroma-FE?
+
+Pleroma-FE is the default user-facing frontend for Pleroma. It's user interface is modeled after Qvitter which is modeled after an older Twitter design. It provides a simple 2-column interface for microblogging. While being simple by default it also provides many powerful customization options.
+
+## How can I use it?
+
+If your instance uses Pleroma-FE, you can acces it by going to your instance (e.g. <https://pleroma.soykaf.com>). You can read more about it's basic functionality in the [Pleroma-FE User Guide](./USER_GUIDE.md). We also have [a guide for administrators](./CONFIGURATION.md) and for [hackers/contributors](./HACKING.md).