|
|
@@ -71,15 +71,18 @@ Additionally, Modpol seeks to counteract the tendency for "[implicit feudalism](
|
|
|
|
|
|
It is certainly possible to use Modpol to replicate practices of implicit feudalism, such as all-powerful admins, but doing so requires extra work to overcome these defaults.
|
|
|
|
|
|
-## Documentation (LDoc)
|
|
|
+## Documentation
|
|
|
|
|
|
-Documentation was generated using LDoc. To generate basic documentation for every page, use the following command.
|
|
|
+Various guides are available at the [GitLab wiki](https://gitlab.com/medlabboulder/modpol/-/wikis/home).
|
|
|
+
|
|
|
+Read documentation of functions and modules at `docs/doc/index.html`. Documentation was generated using [LDoc](https://stevedonovan.github.io/ldoc/). To generate basic documentation for every page, download `ldoc` and use the following command:
|
|
|
|
|
|
```
|
|
|
-/modpol/documentation$ ldoc ..
|
|
|
+$ cd docs/
|
|
|
+$ ldoc ..
|
|
|
```
|
|
|
|
|
|
-This will not generate the same index page and sidebar as the documentation provided.
|
|
|
+This will not generate the same index page and sidebar as the documentation provided; the appropriate structure needs to be added manually.
|
|
|
|
|
|
## Credits
|
|
|
|
Nathan Schneider