Browse Source

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
underscore-world
Ilja lain 3 months ago
parent
commit
08b593746f
2 changed files with 8 additions and 2 deletions
  1. +0
    -2
      docs/USER_GUIDE.md
  2. +8
    -0
      docs/index.md

+ 0
- 2
docs/USER_GUIDE.md View File

@@ -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.


+ 8
- 0
docs/index.md View File

@@ -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).

Loading…
Cancel
Save