Skip to content

Provide real documentation

Instead of a single bloated readme, we should provide a real documentation as this project grows.

We should especially add information about how to use this project:

  • What can be configured
  • How can something be configured
  • How to configure the project to be adjusted to your needs, with examples to understand the possibilities.

Of course this involves the following steps:

  • Migrate readme to documentation
  • Render documentation (depending on hosting / integration, see below)
  • Publish documentation (depending on hosting / integration, see below)

Therefore: