Merge remote-tracking branch 'origin/develop' into develop

.gitignore

@@ -42,6 +42,8 @@ local.properties
 ## Ignore Visual Studio temporary files, build results, and
 ## files generated by popular Visual Studio add-ons.
 
+.vscode
+
 # User-specific files
 *.suo
 *.user

README.md

@@ -1,80 +1,21 @@
 [![Moose-Includes](https://github.com/FlightControl-Master/MOOSE/actions/workflows/build-includes.yml/badge.svg?branch=master)](https://github.com/FlightControl-Master/MOOSE/actions/workflows/build-includes.yml)
 
-# MOOSE framework
+<img src="https://github.com/FlightControl-Master/MOOSE/blob/master/docs/images/classes/overview.jpg" alt="MOOSE" style="width:600px;"/>
 
-MOOSE is a **M**ission **O**bject **O**riented **S**cripting **E**nvironment, and is meant for mission designers in DCS World.
+You can find documentation for MOOSE in the following places:
-It allows to quickly setup complex missions using pre-scripted scenarios using the available classes within the MOOSE Framework.
 
+- Generated documentation of all MOOSE classes:
+  - For the `master` branch: [MOOSE_DOCS]
+  - For the `develop` branch: [MOOSE_DOCS_DEVELOP]
+- Documentation:
+  - The old Guides can be found in our [archive].
+  - Visit our new documentation at the [MOOSE GitHub page].
+- Overview of all [MOOSE repositories] on GitHub.
 
-##  MOOSE Framework Goal
+<br/>
-
-The goal of MOOSE is to allow mission designers to enhance their scripting with mission orchestration objects, which can be instantiated from defined classes within the framework. This will allow to write mission scripts with minimal code embedded. Of course, the richness of the framework will determine the richness of the misson scenarios. 
-The MOOSE is a service that is produced while being consumed ... , it will evolve further as more classes are developed for the framework, and as more users are using it.
-MOOSE is not a one-man show, it is a collaborative effort and meant to evolve within a growing community around the framework.
-Within the community, key users will start supporting, documenting, explaining and even creating new classes for the framework.
-It is the ambition to grow this framework as a de-facto standard for mission designers to use.
-  
-  
-##  MOOSE Repositories
-
-The underlying picture documents the different repositories in the MOOSE framework. The white ones are edited and are the source of the framework.
-The red ones contain generated artefacts. See further the explanation for each repository.
-
-![Graphic](https://raw.githubusercontent.com/FlightControl-Master/MOOSE_DOCS/master/Configuration/Master.png)
- 
-  
-###   [MOOSE](https://github.com/FlightControl-Master/MOOSE) - For edit and development
-
-This repository contains the source lua code of the MOOSE framework.
-  
-  
-###   [MOOSE_INCLUDE](https://github.com/FlightControl-Master/MOOSE_INCLUDE) - For use and generated 
-
-This repository contains the Moose.lua file to be included within your missions. Note that the Moose\_.lua is technically the same as Moose.lua, but without any commentary or unnecessary whitespace in it. You only need to load **one** of those at the beginning of your mission.
-  
- 
-###   [MOOSE_DOCS](https://github.com/FlightControl-Master/MOOSE_DOCS) - Not for use
-
-This repository contains the generated documentation and pictures and other references. The generated documentation is reflected in html and is published at: https://flightcontrol-master.github.io/MOOSE_DOCS/
-  
-  
-###   [MOOSE_MISSIONS](https://github.com/FlightControl-Master/MOOSE_MISSIONS) - For use and generated
-
-This repository contains all the demonstration missions in packed format (*.miz), and can be used without any further setup in DCS WORLD.
-  
-  
-###   [MOOSE_MISSIONS_DYNAMIC](https://github.com/FlightControl-Master/MOOSE_MISSIONS_DYNAMIC) - For use and generated
-
-This repository contains all the demonstration missions in packed format (*.miz), but MOOSE is dynamically loaded from your disk! These missions are to be used by beta testers of the MOOSE framework and are not for end uers!!!!
- 
-    
-###   [MOOSE_MISSIONS_UNPACKED](https://github.com/FlightControl-Master/MOOSE_MISSIONS_UNPACKED) - For edit and development
-
-This repository contains all the demonstration missions in unpacked format. That means that there is no .miz file included, but all the .miz contents are unpacked.
-
-
-##  [MOOSE Web Site](https://flightcontrol-master.github.io/MOOSE_DOCS/)
-
-Documentation on the MOOSE class hierarchy, usage guides and background information can be found here for normal users, beta testers and contributors.
-
-![Click on this link to browse to the MOOSE main web page.](https://raw.githubusercontent.com/FlightControl-Master/MOOSE_DOCS/master/Configuration/Site.png)
-  
-  
-  
-##  [MOOSE Youtube Tutorials](https://youtube.com/playlist?list=PLLkY2GByvtC2ME0Q9wrKRDE6qnXJYV3iT)
-
-Pene has kindly created a [tutorial series for MOOSE](https://youtube.com/playlist?list=PLLkY2GByvtC2ME0Q9wrKRDE6qnXJYV3iT)
- with various videos that you can watch.
-  
-  
-    
-##  [MOOSE on Discord](https://discord.gg/aQtjcR94Qf)
-
-MOOSE has a living (chat and video) community of users, beta testers and contributors. The gathering point is a service provided by discord.com. If you want to join this community, just click Discord and you'll be on board in no time.
-  
-   
-
-Kind regards,
-The Moose Team
-  
 
+[MOOSE_DOCS]: https://flightcontrol-master.github.io/MOOSE_DOCS/Documentation/index.html
+[MOOSE_DOCS_DEVELOP]: https://flightcontrol-master.github.io/MOOSE_DOCS_DEVELOP/Documentation/index.html
+[archive]: https://flightcontrol-master.github.io/MOOSE/archive/
+[MOOSE GitHub page]: https://flightcontrol-master.github.io/MOOSE/
+[MOOSE repositories]: https://flightcontrol-master.github.io/MOOSE/repositories.html

docs/advanced/desanitize-dcs.md

@@ -0,0 +1,93 @@
+---
+title: De-Sanitize DCS
+parent: Advanced
+nav_order: 2
+---
+# De-Sanitize the DCS scripting environment
+{: .no_toc }
+
+1. Table of contents
+{:toc}
+
+De-Sanitize is the a modification performed by the user which disables some
+security features of DCS. Without de-sanitizing not all functions of Moose
+are available. Let's take a closer look and explain the details:
+
+- In the File-Explorer, navigate to your DCS main [installation folder].
+- Navigate to the folder `Scripts` and open the file `MissionScripting.lua` with
+  a good editor like [Notepad++]{:target="_blank"}.
+
+The original file should look like this:
+
+```lua
+--Initialization script for the Mission lua Environment (SSE)
+
+dofile('Scripts/ScriptingSystem.lua')
+
+-- Sanitize Mission Scripting environment
+-- This makes unavailable some unsecure functions. 
+-- Mission downloaded from server to client may contain potentialy harmful lua code
+-- that may use these functions.
+-- You can remove the code below and make availble these functions at your own risk.
+
+local function sanitizeModule(name)
+	_G[name] = nil
+	package.loaded[name] = nil
+end
+
+do
+	sanitizeModule('os')
+	sanitizeModule('io')
+	sanitizeModule('lfs')
+	_G['require'] = nil
+	_G['loadlib'] = nil
+	_G['package'] = nil
+end
+```
+
+In line 17, 18 and 19 the method `sanitizeModule` disables the modules `os`, `io` and `lfs`.
+
+{: .warning }
+> This is a security feature to avoid harmfull actions to be executed from
+> inside a mission.
+>
+> ***Disable this on your own risk!***
+
+If the lines will be disabled the lua code inside of missions can use the
+following functionality again:
+
+- `os` (at line 17):
+  - Execution of commands from the operation system is allowed again.
+    This is needed by some Classes when using [Text-To-Speech] with [SRS]{:target="_blank"}.
+    But in theory it can also run harmful commands.
+
+- `io` and `lfs` (at line 18 & 19):
+  - Different libraries to access files on your hard disk or do other io
+    operations. This is needed by some clases if you want to save and/or
+    read data. Like persistance for CSAR.
+    But it may be abused to access or modify sensitive files owned by the user.
+
+If you put two dashes (`--`) in front of each of the lines 17 - 19 the
+protection is disabled and the lower part of the file should look this:
+
+```lua
+do
+	--sanitizeModule('os')
+	--sanitizeModule('io')
+	--sanitizeModule('lfs')
+	_G['require'] = nil
+	_G['loadlib'] = nil
+	_G['package'] = nil
+end
+```
+
+Save the file and it will enable the DCS Lua sandbox to access stuff on your computer.
+
+{: .note }
+> After each update of DCS you need to repeat this because each update will
+> overwrite this file by default.
+
+[installation folder]: ../beginner/tipps-and-tricks.md#find-the-installation-folder-of-dcs
+[Notepad++]: https://notepad-plus-plus.org/downloads/
+[Text-To-Speech]: text-to-speech.md
+[SRS]: https://github.com/ciribob/DCS-SimpleRadioStandalone/releases/latest

docs/advanced/eclipse-installation.md

@@ -0,0 +1,84 @@
+---
+parent: Advanced
+nav_order: 1
+---
+# Eclipse Installation
+{: .no_toc }
+
+1. Table of contents
+{:toc}
+
+This guide describes how to install [Eclipse] and install the necessary [Lua]
+environment.
+
+{: .note }
+> Note that the [Lua] environment is not actively supported any more
+> by Oracle. Especially the LDT plugin is not working when installed from the
+> market place. The problem and solution is nicely described [in this topic].
+
+## Prerequisites
+
+* Download Eclipse from [eclipse.org].
+* Download [dltk-core].
+* Download or clone [MOOSE repository] (select branch you want `master` or `develop`).
+
+## Install Eclipse
+
+First you need to install [Eclipse]. It will ask you what kind of environment
+you use, *e.g.* C++ or Java or something else. This does not really matter since
+we want to use it for Lua and need to install the plugin for [Lua] later.
+
+## Install dltk-core
+
+Before you can install the LDT plugin, you first need to add dltk-core zip file
+to the available software sites. Open eclipse, go to the help menu and follow
+the steps in the image:
+
+![eclipse-install-ldk-1](../images/install/eclipse/ldk-1.png)
+
+This should then be in the available software sites.
+
+![eclipse-install-ldk-2](../images/install/eclipse/ldk-2.png)
+
+## Install LDT Plugin
+Open eclipse and from the "Help" menu open the "Eclipse Marketplase":
+
+![Eclipse-Install_Lua_1](../images/install/eclipse/lua-1.png)
+
+In the "Search" tab find "lua" and install the "Lua Development Tools 1.4.x":
+
+![Eclipse-Install_Lua_2](../images/install/eclipse/lua-2.png)
+
+## Setup Lua Project for MOOSE
+Now that Eclipse and LDT are installed, we need to add MOOSE as a LUA project.
+Open Eclipse and from the "File" menu select "Other":
+
+![Eclipse-Lua_Project_1](../images/install/eclipse/project-1.png)
+
+In the wizard window that opens select "Lua Project":
+
+![Eclipse-Lua_Project_2](../images/install/eclipse/project-2.png)
+
+Setup the Lua project as described in the image. You need to specify the path to
+where you downloaded the MOOSE repository:
+
+![Eclipse-Lua_Project_3a](../images/install/eclipse/project-3.png)
+
+From the "Project" tab select "Properties" and add `Moose/Moose Development/Moose`
+to the build path as shown below:
+
+![Eclipse-Lua_Project_4](../images/install/eclipse/project-4.png)
+
+## Finally
+Now you are done!
+Check that your script explorer looks like in the image below and that the
+intellisense is working when you open a MOOSE file:
+
+![Eclipse-Lua_Project_5](../images/install/eclipse/project-5.png)
+
+[Eclipse]: https://www.eclipse.org
+[Lua]: https://www.lua.org/
+[eclipse.org]: https://www.eclipse.org/downloads/
+[dltk-core]: https://www.eclipse.org/downloads/download.php?file=/technology/dltk/downloads/drops/R5.7/R-5.7.1-201703020501/dltk-core-R-5.7.1-201703020501.zip
+[MOOSE repository]: https://github.com/FlightControl-Master/MOOSE/
+[in this topic]: https://www.eclipse.org/forums/index.php/t/1101907/

docs/advanced/index.md

@@ -0,0 +1,20 @@
+---
+has_children: true
+nav_order: 3
+---
+
+# Advanced
+
+In this section we will add the documentation for all subjects that go beyond
+the beginner topics, but which are interesting for mission builders or power
+users.
+
+{: .note }
+> This documentation is WIP (work in progress) and it will take some time to
+> fill it with usefull and up to date informations. Please be patient and check
+> back here from time to time to see if there is anything new for you.
+
+If you cannot find the information you are looking for here in the new
+documentation, please take a look at the [archive].
+
+[archive]: ../archive/index.md

docs/advanced/text-to-speech.md

@@ -0,0 +1,159 @@
+---
+parent: Advanced
+nav_order: 2
+---
+# Text to Speech
+{: .no_toc }
+
+1. Table of contents
+{:toc}
+
+This guide describes how to configure and use [Text-To-Speech{:target="_blank"}
+(or TTS) with MOOSE. We use [DCS Simple Radio Standalone] (DCS-SRS) to generate
+the audio and send it to the client. SRS is a well known VOIP client simulating
+a radio in DCS.
+
+{: .note }
+> Only clients which uses SRS are able to hear the generated radio calls.
+> This is not compatible with the in game VOIP audio system from Eagle Dynamics!
+
+## Prerequisites
+
+- Download and install [DCS Simple Radio Standalone]{:target="_blank"} (DCS-SRS).
+- Use a good text editor like [Notepad++]{:target="_blank"}.
+- Create a simple test mission with Moose included and a "... from parking hot"
+  airplane or helicopter.
+- [De-Sanitize the DCS scripting environment].
+
+## Start SR-Server and connect the client
+
+- Navigate to the install directory of SRS.
+    - As default it should be located here: `C:\Program Files\DCS-SimpleRadio-Standalone`
+
+- We are interested in the executable files:
+
+    ![srs-executables](../images/install/text-to-speech/srs-executables.png)
+
+- Start the server by double click on `SR-Server.exe`.<br />
+  It should looks like this:
+
+    ![srs-server](../images/install/text-to-speech/srs-server.png)
+
+- Start the `SR-ClientRadio.exe`.
+
+- Connect to the local server:
+  - Use the port shown in the server window (default is 5002).
+  - Use the ip of the windows loopback device (which is 127.0.0.1).
+  - Example: `127.0.0.1:5002`
+
+    ![srs-client](../images/install/text-to-speech/srs-client.png)
+
+- If asked if you want to allow changes to your PC, say yes.
+
+- After you clicked on Connect and some seconds the status should look like this:
+
+    ![srs-status-1](../images/install/text-to-speech/srs-status-1.png)
+
+- Your server UI now shows 1 connected client.
+
+- Click on „toggle radio overlay“ on the client. A small grey window will pop-up.
+
+## Start DCS World and your test mission
+
+- Jump into a plane or helicopter.
+
+- The connection status on the client UI and overlay should be changing
+  and shows the available radios of the module and it's frequencies:
+
+    ![srs-overlay](../images/install/text-to-speech/srs-overlay.png)
+
+- The third green connector on the client UI should be green now:
+
+    ![srs-status-2](../images/install/text-to-speech/srs-status-2.png)
+
+## Command line test with Power Shell
+
+- Use the search icon in windows to locate and start `PowerShell`, you’ll get a
+  blue terminal window:
+
+    ![powershell-1](../images/install/text-to-speech/powershell-1.png)
+
+- Now navigate in PowerShell to the SRS install folderwith the following command:
+
+    `cd 'C:\Program Files\DCS-SimpleRadio-Standalone\'`
+
+    {: .note }
+    > Change the path if you choose another installation directory for SRS.
+
+- Type `dir` and press enter to get a listing of all files in the directory.
+  - `DCS-SR-ExternalAudio.exe` should be amongst them.
+
+    ![powershell-2](../images/install/text-to-speech/powershell-2.png)
+
+- Now we are going to create a text-to-speech command which should be sent to
+  the radio on your airplane or helicopter.
+  - The parameter `-t` will define the text to send.
+  - The frequency will be defined with `-f`. Adopt it to match the frequency of
+    your airplane or helicopter! For example 251.
+  - And the modulation is set by `-m`. For example AM.
+  - Define the coalition with `-c`. 0 is Spectator, 1 is Red, 2 is Blue.
+
+    `.\DCS-SR-ExternalAudio.exe -t "Hello Moosers" -f 251 -m AM -c 2`
+
+  - The console output should look like this:
+
+    ![powershell-3](../images/install/text-to-speech/powershell-3.png)
+
+**If you can hear the voice on the cockpit radio, you are done!**
+
+If you get UpnP/Network errors, you need to allow DCS-SR-ExternalAudio.exe to
+traverse your firewall.
+
+{: .note }
+> You can raun `DCS-SR-ExternalAudio.exe` without any parameters to get help.
+
+## Firewall Setup
+
+- On Windows search, type Firewall and open „Firewall- and Network Protection“.
+  Click on „Extended Setting“ (you need admin rights to do that).
+
+- You will need two incoming and two outgoing rules (4 overall), right-click on
+  incoming/outgoing rules to create new rules.
+
+- Give the rule a nice name:
+
+- Protocols and Services – you need to create ONE rule for TCP and another one
+  for UDP. Select TCP from the drop down:
+
+- On Programs and Services, enable 'this program' and use search to locate and
+  select DCS-SR-ExternalAudio.exe:
+
+- Click „ok“ to save and close the rule.
+
+- Repeat for UDP.
+
+- Repeat twice for outgoing, one for TCP and one for UDP.
+
+- You’re done and can return to 'Command line test'.
+
+## Google TTS
+
+- For Google TTS you need to have a Google Cloud Account (a testing one will do).
+
+- You can start here: <https://cloud.google.com/text-to-speech/>
+
+- You need to create a projekt and enable the 'Cloud Text-To-Speech API' in it.
+
+- You also need to create a service-account and create a `.json` key file for it.
+
+There’s a lot of supporting information on the Google Cloud Site to help you
+with that. Similar to 'Command line test', you can test your setup on the
+command line. Here is an example that assumed your .json key file resides in the
+SRS directory:
+
+`.\DCS-SR-ExternalAudio.exe -t "Hello Moosers" -f 251 -m AM -c 2 -z -G .\yourgoogleaccount.json`
+
+[Text-To-Speech]: https://en.wikipedia.org/wiki/Speech_synthesis
+[DCS Simple Radio Standalone]: https://github.com/ciribob/DCS-SimpleRadioStandalone/releases/latest
+[De-Sanitize the DCS scripting environment]: desanitize-dcs.md
+[Notepad++]: https://notepad-plus-plus.org/downloads/

docs/archive/index.md

@@ -1,7 +1,7 @@
 ---
 title: Archive
 has_children: true
-nav_order: 4
+nav_order: 99
 has_toc: false
 ---
 

docs/beginner/index.md

@@ -0,0 +1,19 @@
+---
+has_children: true
+nav_order: 2
+---
+
+# Beginner
+
+In this section we will add all informations needed for your first steps using
+MOOSE.
+
+{: .note }
+> This documentation is WIP (work in progress) and it will take some time to
+> fill it with usefull and up to date informations. Please be patient and check
+> back here from time to time to see if there is anything new for you.
+
+If you cannot find the information you are looking for here in the new
+documentation, please take a look at the [archive].
+
+[archive]: ../archive/index.md

docs/beginner/tipps-and-tricks.md

@@ -0,0 +1,29 @@
+---
+parent: Beginner
+nav_order: 99
+---
+# Tipps and tricks
+{: .no_toc }
+
+1. Table of contents
+{:toc}
+
+This section we put a lot of usefull informations needed by beginners.
+
+## Find the installation folder of DCS
+
+It depends on the platform and the version you choosed to install:
+
+- [DCS World Steam Edition]{:target="_blank"} from Steam.
+  - To find the folder right click on the game in Steam.
+  - Open Properties / Installed Files / Browse
+
+- [DCS World Standalone installer]{:target="_blank"} from Eagle Dynamics website.
+  - Default installation locations:
+    - Stable: C:\Program Files\Eagle Dynamics\DCS World
+    - OpenBeta: C:\Program Files\Eagle Dynamics\DCS World.Openbeta
+  - If you changed the installation folder of the Standalone version, right
+    click on the game icon, open Properties and click on `Open File Location`.
+
+[DCS World Steam Edition]: https://store.steampowered.com/app/223750/DCS_World_Steam_Edition/
+[DCS World Standalone installer]: https://www.digitalcombatsimulator.com/en/downloads/world/

docs/developer/buildsystem/build-docs.md

@@ -1,5 +1,6 @@
 ---
 parent: Build system
+grand_parent: Developer
 nav_order: 2
 ---
 
@@ -56,6 +57,25 @@ Main build steps to create the class documentation are defined in [.github/workf
     - Copy build result to `MOOSE_DOCS` folder.
     - Push results to the target repository.
 
+# Build a preview locally
+
+To generate a preview of the class documentation go into the folder
+`docker/build-docks` and run `docker compose up`. It will create a Docker image
+and start a Docker container. Within this container all needed software packages
+are included to build to class documentation.
+
+- You need a working installation of [Docker].
+- In the main repository folder a new folder `build` will be created.
+- Subfolders `build/docs` and `build/tools` will be generated.
+- Repo `Applevangelist/luadocumentor` will be checked out to `build/tools/luadocumentor`
+- `luadocumentor.lua` will be executed and writes the output to `build/docs`.
+
+{: .note }
+> If [MOOSE_DOCS] is checked out to `/moose/build/MOOSE_DOCS` by the developer
+> manually, then the generated files are also copied into `/moose/build/MOOSE_DOCS/Documentation/`.
+> This allows to run `docker compose up` in `/moose/build/MOOSE_DOCS/docker/`,
+> so the full result can be checked.
+
 [tree]: https://wiki.ubuntuusers.de/tree/
 [LuaDoc]: https://keplerproject.github.io/luadoc/
 [LuaDocumentor]: https://luarocks.org/modules/luarocks/luadocumentor
@@ -71,3 +91,4 @@ Main build steps to create the class documentation are defined in [.github/workf
 [Lua]: https://www.lua.org/
 [LuaRocks]: https://luarocks.org/
 [.github/workflows/build-docs.yml]: https://github.com/FlightControl-Master/MOOSE/blob/master/.github/workflows/build-docs.yml
+[Docker]: https://www.docker.com/

docs/developer/buildsystem/build-includes.md

@@ -1,5 +1,6 @@
 ---
 parent: Build system
+grand_parent: Developer
 nav_order: 1
 ---
 
@@ -21,8 +22,8 @@ Main build steps to create the include files are defined in [.github/workflows/b
 
 - Run the build steps:
     - Run `./Moose Setup/Moose_Create.lua` to create `Moose.lua`.
-    - Run `./Moose Setup/Moose_Create.lua` to create dynamic `Moose.lua` to
+    - Run `./Moose Setup/Moose_Create.lua` to create dynamic `Moose.lua` which
-      load individual Lua class files used by Moose developers.
+      loads individual Lua class files used by Moose developers.
     - Run [LuaSrcDiet] to compress the [Lua] code and create `Moose_.lua`
     - Run [LuaCheck] to find errors in the code. Warnings are ignored, because
       there are a lot of warnings, which cannot be resolved by the Moose team.
@@ -34,6 +35,23 @@ Main build steps to create the include files are defined in [.github/workflows/b
     - Copy build result to `MOOSE_INCLUDE` folder
     - Push results to [MOOSE_INCLUDE] repository
 
+# Build a preview locally
+
+To generate a preview of the include files go into the folder
+`docker/build-includes` and run `docker compose up`. It will create a Docker
+image and start a Docker container.
+Within this container all needed software packages are included to build the
+include files.
+
+- You need a working installation of [Docker].
+- In the main repository folder a new folder `build` will be created.
+- The following subfolders will be generated:
+    - `build/result/Moose_Include_Dynamic` and
+    - `build/result/Moose_Include_Static`
+- `./Moose Setup/Moose_Create.lua` will be executed to generate the target files
+- [LuaSrcDiet] will be executed to generate the target file `Moose_.lua`
+- [LuaCheck] runs to find errors
+
 [.github/workflows/build-includes.yml]: https://github.com/FlightControl-Master/MOOSE/blob/master/.github/workflows/build-includes.yml
 [tree]: https://wiki.ubuntuusers.de/tree/
 [lua5.3]: https://www.lua.org/manual/5.3/
@@ -43,3 +61,4 @@ Main build steps to create the include files are defined in [.github/workflows/b
 [MOOSE_INCLUDE]: https://github.com/FlightControl-Master/MOOSE_INCLUDE
 [LuaSrcDiet]: https://github.com/jirutka/luasrcdiet
 [Lua]: https://www.lua.org/
+[Docker]: https://www.docker.com/

docs/developer/buildsystem/gh-pages.md

@@ -1,5 +1,6 @@
 ---
 parent: Build system
+grand_parent: Developer
 nav_order: 3
 ---
 
@@ -37,6 +38,20 @@ This can be displayed as follows:
 - Open a browser with the following URL: `http://127.0.0.1:4000/`.
 - After a change of the [Markdown] files, wait some seconds and press F5 in the browser.
 
+{: .warning }
+> Some changes are not processed properly with this procedure. It is then
+> necessary to stop and restart the container once. On startup everything is
+> always regenerated.
+
+# Run linkinator to find brocken links
+
+When changing this documentation it is very useful to run linkinator to find broken links.
+This can be done as follows:
+
+- You need a working installation of [Docker].
+- Go to the `docker/gh-pages-check` subfolder.
+- Run `docker compose up`.
+
 [GitHub Pages]: https://pages.github.com/
 [MOOSE]: https://github.com/FlightControl-Master/MOOSE
 [Just the Docs]: https://github.com/just-the-docs/just-the-docs

docs/developer/buildsystem/index.md

@@ -1,6 +1,9 @@
 ---
+layout: default
+title: Build system
+parent: Developer
 has_children: true
-nav_order: 3
+nav_order: 99
 ---
 
 # Build system

docs/developer/buildsystem/local-test.md

@@ -1,5 +1,6 @@
 ---
 parent: Build system
+grand_parent: Developer
 nav_order: 4
 ---
 

docs/developer/index.md

@@ -0,0 +1,21 @@
+---
+title: Developer
+has_children: true
+nav_order: 4
+---
+
+# Developer
+
+All information in this section is primarily intended for developers who extend
+or maintain the Moose program code. Of course, this information may also be of
+interest to others who want to learn more about the background of MOOSE.
+
+{: .note }
+> This documentation is WIP (work in progress) and it will take some time to
+> fill it with usefull and up to date informations. Please be patient and check
+> back here from time to time to see if there is anything new for you.
+
+If you cannot find the information you are looking for here in the new
+documentation, please take a look at the [archive].
+
+[archive]: ../archive/index.md

docs/repositories.md

@@ -1,6 +1,6 @@
 ---
 title: Repositories
-nav_order: 2
+nav_order: 5
 ---
 
 # MOOSE Repositories