Skip to content

Add "Guides" folder into docs/ to provide storys on how to do certain things

Created by: andygrunwald

Context

Right now it is hard to reach a certain goal with LanSuite if you are not deep into the system. Typical goals are:

  • How to setup a docker env with the latest verison of LanSuite with the Database of my existing one?
  • How do i test this System quickly?
  • How to test the LanSuite system against multiple versions of MySQL?
  • How to write an own module?
  • How to write an own design?

and so on. I think there are multiple guides that can be written

The idea: Create a docs/guides/ folder. Every guide is represented by one Markdown file like test-lansuite-with-your-live-database.md. In the README.md of docs/guides/ all guides are linked.

For this the API doc generation by php documentator needs to be passed to docs/api/ or docs/generated.