diff options
| author | Ilja <pleroma@spectraltheorem.be> | 2020-07-03 10:17:42 +0000 |
|---|---|---|
| committer | lain <lain@soykaf.club> | 2020-07-03 10:17:42 +0000 |
| commit | 08b593746faf54ac41df25bb2cc5a1f72ae1a9b5 (patch) | |
| tree | 1ce479a2e455de1c0ba851e7c1110e66bd56a903 /docs | |
| parent | e1cf6bd41ced8f1d85dde6ba557ca6ea28bd6028 (diff) | |
FE part of BE issue 1586 provide index md
* I added an index.md which will be the landing page for the docs. It has an explanation of Pleroma-FE from the user point of view
* See also BE MR: https://git.pleroma.social/pleroma/pleroma/-/merge_requests/2669
* And issue: https://git.pleroma.social/pleroma/pleroma/-/issues/1586
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/USER_GUIDE.md | 2 | ||||
| -rw-r--r-- | docs/index.md | 8 |
2 files changed, 8 insertions, 2 deletions
diff --git a/docs/USER_GUIDE.md b/docs/USER_GUIDE.md index f417f33d..241ad331 100644 --- 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 new file mode 100644 index 00000000..8764f9ab --- /dev/null +++ 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). |