janishutz/libreevent
1
0
Fork 0
mirror of https://github.com/janishutz/libreevent.git synced 2025-11-25 13:24:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

add more documentation

Browse Source
This commit is contained in:
Janis Hutz
2023-07-29 11:08:32 +02:00
parent 0ef138c865
commit 6083ec262c
5 changed files with 19 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
website/src/admin-panel/pages.md
View File

@@ -1 +1,3 @@
# Pages
With the page editor you can easily create the start page (the landing page, so the page that gets displayed when the user visits the website). You may select one of a few templates which you can choose [here](TODO: ADD LINK). Then you should upload the promotional text and a few images. The image count depends on the template selected. If you want to use a more feature rich start page, please consider moving libreevent to a sub-domain and building a complete website on the main domain. You can get beautiful fully custom websites built for you [here](https://development.janishutz.com).

2
website/src/admin-panel/plugins.md
View File

@@ -1 +1,3 @@
# Plugins
libreevent can be extended easily with plugins. Plugins add additional features and can be official or community made. You can see which plugins are official by their badge. When installing plugins, you need to remember that a server restart is required to activate the plugins as libreevent does not feature hot module loading (yet). You then can manage the plugins using their built-in settings page that they ship with.

1
website/src/contributing/code-of-conduct.md Normal file
View File

@@ -0,0 +1 @@
# Code of Conduct

2
website/src/contributing/design-guidelines.md Normal file
View File

@@ -0,0 +1,2 @@
# Design Guidelines

9
website/src/contributing/plugins.md
View File

@@ -1 +1,10 @@
# Contributing Plugins
If you wish to contribute plugins and have them accepted into the official repository then your plugin has to:
- fulfill the code layout requirements given by the linter config
- follow the libreevent [design guidelines](&/contributing/design-guidelines)
- conform to our [code of conduct](&/contributing/code-of-conduct)
- not contain any immediately obvious flaws (as layed out in the code of conduct), be it in terms of security or reliability
- provide all necessary files for libreevent
- offer settings if possible and necessary and a way to graphically edit them
- have extensive documentation on its usage. Once accepted into the official repos, the documentation will be added to the official documentation.