Jingga/oms-Help
1
0
Fork 0
mirror of https://github.com/Karaka-Management/oms-Help.git synced 2026-01-11 12:58:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc fixes

Browse Source
This commit is contained in:
Dennis Eichhorn 2022-04-21 23:52:00 +02:00
parent 65c72c0e3f
commit 3cd33ec950
3 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@ -16,7 +16,7 @@ Generally, the development philosophy is result orientated. This means that anyo
Developers are encouraged to pick open tasks with high priorities according to their own skill level. Senior developers may directly assign tasks to developers based on their importance. New developers may find it easier to start with a task that has a low priority as they often also have a lower difficulty.
Open tasks can be found in the project overview: [PROJECT.md](../Project/PROJECT.md)
Open tasks can be found in the project overview: [PROJECT.md](https://github.com/Karaka-Management/Organization-Guide/blob/master/Project/PROJECT.md)
Tasks currently in development are prefixed in the priority column with an asterisk `*` and a name tag in the task description of the developer who is working on the task.

18
Controller/BackendController.php
View File

@ -43,7 +43,7 @@ final class BackendController extends Controller
* @since 1.0.0
* @codeCoverageIgnore
*/
public function viewHelp(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface
public function viewHelp(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{
$view = new View($this->app->l11nManager, $request, $response);
$view->setTemplate('/Modules/Help/Theme/Backend/help');
@ -63,13 +63,13 @@ final class BackendController extends Controller
* @since 1.0.0
* @codeCoverageIgnore
*/
public function viewHelpGeneral(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface
public function viewHelpGeneral(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{
$view = new View($this->app->l11nManager, $request, $response);
$path = $this->getHelpGeneralPath($request);
$toParse = \file_get_contents($path);
$summary = \file_get_contents(__DIR__ . '/../../../Documentation/SUMMARY.md');
$summary = \file_get_contents(__DIR__ . '/../../../User-Guide/SUMMARY.md');
$content = Markdown::parse($toParse === false ? '' : $toParse);
$navigation = Markdown::parse($summary === false ? '' : $summary);
@ -94,13 +94,13 @@ final class BackendController extends Controller
private function getHelpGeneralPath(RequestAbstract $request) : string
{
if ($request->getData('page') === 'README' || $request->getData('page') === null) {
$path = \realpath(__DIR__ . '/../../../Documentation/README.md');
$path = \realpath(__DIR__ . '/../../../User-Guide/README.md');
} else {
$path = \realpath(__DIR__ . '/../../../Documentation/' . $request->getData('page') . '.md');
$path = \realpath(__DIR__ . '/../../../User-Guide/' . $request->getData('page') . '.md');
}
if ($path === false) {
$path = \realpath(__DIR__ . '/../../../Documentation/README.md');
$path = \realpath(__DIR__ . '/../../../User-Guide/README.md');
}
return $path === false ? '' : $path;
@ -118,7 +118,7 @@ final class BackendController extends Controller
* @since 1.0.0
* @codeCoverageIgnore
*/
public function viewHelpModuleList(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface
public function viewHelpModuleList(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{
$view = new View($this->app->l11nManager, $request, $response);
$view->setTemplate('/Modules/Help/Theme/Backend/help-module-list');
@ -140,7 +140,7 @@ final class BackendController extends Controller
* @since 1.0.0
* @codeCoverageIgnore
*/
public function viewHelpModule(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface
public function viewHelpModule(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{
$active = $this->app->moduleManager->getActiveModules();
@ -227,7 +227,7 @@ final class BackendController extends Controller
* @since 1.0.0
* @codeCoverageIgnore
*/
public function viewHelpDeveloper(RequestAbstract $request, ResponseAbstract $response, $data = null) : RenderableInterface
public function viewHelpDeveloper(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : RenderableInterface
{
$view = new View($this->app->l11nManager, $request, $response);
$path = $this->getHelpDeveloperPath($request);

2
Controller/SearchController.php
View File

@ -42,7 +42,7 @@ final class SearchController extends Controller
*
* @since 1.0.0
*/
public function searchHelp(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
public function searchHelp(RequestAbstract $request, ResponseAbstract $response, mixed $data = null) : void
{
$lang = 'en';