[docs] Improve content and generation

Author: salkinium

.circleci/config.yml

@@ -297,9 +297,15 @@ jobs:
           name: Build Homepage
           command: |
             python3 tools/scripts/synchronize_docs.py
-            (cd examples/stm32f469_discovery/blink; lbuild -D ::generate_module_docs=True build -m "modm:**")
-            (cd docs/src/reference && ln -s ../../../examples/stm32f469_discovery/blink/modm/docs/module)
+            python3 tools/scripts/generate_module_docs.py
             (cd docs && mkdocs build)
+      # FIXME: Allow localhost:port to work with Docker
+      # - run:
+      #     name: Check Homepage
+      #     command: |
+      #       apt install -y nodejs npm
+      #       npm install -g broken-link-checker-local
+      #       blcl modm/docs/modm.io/docs -ro --host-requests 100 --filter-level 1
       - persist_to_workspace:
           root: docs
           paths:

.mailmap

@@ -1,6 +1,9 @@
+Amar <fb39ca4@gmail.com>
+Amarok McLion <amarokmclion@gmail.com>
 Andre Gilerson <andre.gilerson@gmail.com>
 Antal Szabó <szabo.antal.92@gmail.com>
 Arjun Sarin <arjun.sarin@rwth.aachen.de>
+Benjamin Weps <benjamin.weps@posteo.de>
 Carl Treudler <cjt@users.sf.net>
 Christian Menard <christian.menard@gmx.de>
 Christoph Rüdi <christoph.ruedi@rwth-aachen.de>
@@ -13,9 +16,11 @@ Georgi Grinshpun <georgi.grinshpun@rwth-aachen.de> <georgi-grinshpun@rwth-aachen
 Georgi Grinshpun <georgi.grinshpun@rwth-aachen.de> <Georgi@FlipFlip>
 Hans Schily <hans.schily@rwth-aachen.de>
 Julia Gutheil <julia.gutheil@rwth-aachen.de>
+Jörg Hoffmann <joerg.hoffmann@bruker.com>
 Kevin Läufer <kevin.laeufer@rwth-aachen.de>
 Kevin Läufer <kevin.laeufer@rwth-aachen.de> <electron.kiwi@gmail.com>
 Lucas Mösch <lucas.moesch@rwth-aachen.de>
+Lucas Mösch <lucas.moesch@rwth-aachen.de> <moesch@lfb.rwth-aachen.de>
 Marten Junga <marten.junga@rwth-aachen.de>
 Martin Esser <martin.esser@rwth-aachen.de>
 Martin Rosekeit <martin.rosekeit@rwth-aachen.de> <martin.rosekeit@rwth-aachen.de>
@@ -24,12 +29,18 @@ Nick Sarten <gen.battle@gmail.com>
 Niclas Rohrer <niclas.rohrer@rwth-aachen.de> <Niclas>
 Niklas Hauser <niklas.hauser@rwth-aachen.de> <niklas.hauser@arm.com>
 Niklas Hauser <niklas.hauser@rwth-aachen.de> <niklas.hauser@gmail.com>
+Niklas Meyer <niklas.meyer@rwth-aachen.de>
+Patrick Servello <patrick.servello@gmail.com>
+Pavel Pletenev <cpp.create@gmail.com>
 Raphael Lehmann <raphael@rleh.de>
 Sascha Schade <stronglytyp3d@gmail.com>
 Sascha Schade <stronglytyp3d@gmail.com> <davedwebb8211@gmail.com>
 Sascha Schade <stronglytyp3d@gmail.com> <strongly-typed@nan>
 Sascha Schade <stronglytyp3d@gmail.com> <stronly@typed.nan>
+Sergiy Yevtushenko <sergiy.yevtushenko@gmail.com>
 Tarik TIRE <kronos@aspbooster.com>
+Thomas Figueroa <thomas@dwarfcraft.com>
 Thorsten Lajewski <thorsten.lajewski@rwth-aachen.de>
 Tomasz Chyrowicz <tomasz.chyrowicz@gmail.com>
+Zawadniak Pedro <zawadniak.pedro@gmail.com>
 Álan Crístoffer <acristoffers@gmail.com>

AUTHORS

@@ -1,32 +1,46 @@
 # How to contribute
 
-We love receiving pull requests. We use them ourselves for reviewing new features and fixing issues in modm.
-If you want to contribute, but don't exactly know what or how, have a look at the [issues we tagged with "help wanted"][help_wanted].
+We love receiving pull requests. We use them ourselves for reviewing new features
+and fixing issues in modm. If you want to contribute, but don't exactly know what
+or how, have a look at the [issues we tagged with "help wanted"][help_wanted].
+
+To start contributing, please fork modm and then start a new branch on top of
+the `develop` branch. We prefer to fast-forward merges, instead of creating a
+merge commit, so your contributions must be up-to-date with develop.
 
-To start contributing, please fork modm and then start a new branch on top of the `develop` branch.
 We recommend prefixing your branch with
 - `feature/` for new functionality, or
 - `fix/` for a bug fix.
 
 Please remember to have a look at [our coding conventions](docs/coding_convention.md).
 
-Once you [open the pull request][pulls], we will review it and might ask you for changes.
-Remember that you can continue to push to your `feature/*` or `fix/*` branches to update the corresponding pull requests!
+Once you [open the pull request][pulls], we will review it and might ask you for
+changes. Remember that you can continue to push to your `feature/*` or `fix/*` 
+branches to update the corresponding pull requests!
+
+Including unit tests is very welcomed and highly recommended. modm has its own
+simple and easy to use unit test framework. Unit tests are placed in the `modm/test`
+subdirectory. [See testing strategies in modm](docs/TESTING.md).
 
-Including unit tests is very welcomed and highly recommended. modm has its own simple and easy to use unit test framework. Unit tests are placed in the `test` subdirectory (e.g. `test/modm/math/filter`) and are run with `make test-{hosted|stm32|avr}`. [See here for more information about testing strategies in modm](docs/TESTING.md).
+The CI first compiles all examples and unittests and then executes the unittests
+for Linux. If all of that passes, it will compile all `:platform:**` modules for
+all supported devices. Please note that your pull request will have to pass ALL
+CI tests in order to be merged.
 
-The CI first compiles all examples and unittests and then executes the unittests for Linux.
-If all of that passes, it will compile all `:platform:**` modules for all supported devices.
-Please note that your pull request will have to pass ALL CI tests in order to be merged.
 
 ## When in doubt, ask
 
-The dedicated maintainer of modm is [@salkinium](https://github.com/salkinium) and you can always ping him.
+The dedicated maintainer of modm is [@salkinium](https://github.com/salkinium)
+and you can always ping him.
 
-If you want to add a new platform, or other significant functionality, we [ask you to discuss that in an issue first][issues]. We are very open to new helping hands, but all of this is still fairly complicated and we want to provide you with tips and additional explanations along the way.
+If you want to add a new platform, or other significant functionality, we
+[ask you to discuss that in an issue first][issues]. We are very open to new
+helping hands, but all of this is still fairly complicated and we want to
+provideyou with tips and additional explanations along the way.
 
-Communication is cheap, implementation is expensive and we don't want to frustrate you.
+Communication is cheap, implementation is expensive and we don't want to
+frustrate you.
 
 [issues]: https://github.com/modm-io/modm/issues
 [pulls]: https://github.com/modm-io/modm/pulls
-[help_wanted]: https://github.com/modm-io/modm/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22
+[help_wanted]: https://github.com/modm-io/modm/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted+🛠%22