🚧 Comments doc

This commit is contained in:
MarceauKa 2019-11-20 19:35:39 +01:00
parent f67ff6b939
commit 8d5e07ac20
2 changed files with 35 additions and 0 deletions

View File

@ -1,5 +1,9 @@
# Unreleased
## Added
- Comments on posts ([documentation](https://github.com/MarceauKa/shaark/blob/dev/documentation/comments.md), issue #45)
## Fixed
- Missing test email translations

31
documentation/comments.md Normal file
View File

@ -0,0 +1,31 @@
# Shaark - Comments
Links, stories, chests and albums can have comments. Comments are **disabled** by default.
Enable them in the settings section.
## Configuration
- **Comments enabled**: Yes or no
- **Guests can see comments**: Yes or no
- **Guests can add comments**: Yes or no
- **New comment moderation**:
- Disabled
- White-listing (see [moderation](#moderation))
- All
⚠️ The **All** option below doesn't take into account comments from logged users.
- **New comment notification**:
- Disabled
- White-listing (see [moderation](#moderation))
- All
⚠️ The **All** option below includes comments from logged users.
## Moderation
Guests are asked to give their name and email address when commenting. Their **email are only visible to you**.
When you have moderated a new comment from a guest (white-listing), their future comments will be **automatically validated** if the guest use the same email address.