Improving Documentation (#220)

Documentation improvement (Related to https://github.com/JohnXLivingston/peertube-plugin-livechat/issues/117)

* new introduction and homepage
* Fix livechat_label shortcode: no line breaks
* refactoring/rewriting user documentation
* troubleshooting section
* Updating documentation po files
* ...
This commit is contained in:
John Livingston
2023-07-25 18:00:41 +02:00
committed by GitHub
parent b0350df34b
commit 8db4f10584
61 changed files with 24341 additions and 858 deletions

View File

@ -5,8 +5,21 @@ You can use the language selector in the left menu to view this documentation in
Some translations are missing or incomplete. In this case, you'll see the English version of the text.
{{% /notice %}}
![Chat screenshot](/peertube-plugin-livechat/images/chat.png?classes=shadow,border&height=200px)
Welcome the **Peertube Livechat Plugin** documentation.
[Peertube](https://joinpeertube.org/) is a decentralized streaming platform, that can provide both live streaming and VOD (Video On Demand) features.
The present plugin adds chatting capatibilities to your Peertube installation, allowing viewers to interract with streamers.
To have a glimpse on this plugin capabilities, checkout the [introduction](/peertube-plugin-livechat/intro/). For more precise informations, please find bellow the summary of this documentation.
{{% notice tip %}}
You can use the searchbox in the left menu to quickly find specific documentation parts.
{{% /notice %}}
{{% notice info %}}
Before updating to a major release, please read the release notes and breaking changes list : [CHANGELOG](https://github.com/JohnXLivingston/peertube-plugin-livechat/blob/main/CHANGELOG.md).
{{% /notice %}}
{{% children style="li" depth="3" description="true" %}}
{{% children style="li" depth="4" description="true" %}}