Strategy for documentation

[carlobeltrame]

We currently have documentation in:

• docs: Use case descriptions
• docu: Setup and deployment instructions
• Wiki: The rest
• Upcoming documentation for ApiInput and EInput components
• Upcoming documentation for translation file structure #528
• Upcoming documentation about timezones / UTC and more in the API #581
• (also Swagger OpenAPI Documentation)

I'd like to propose to move all documentation (except for OpenAPI) to the wiki, since that can be easily edited without opening a PR for each typo. Downside: When changing something, we also have to remember to update the wiki.

[usu]

Agree for

• Setup, deployement, general docu, etc. --> wiki
• Swagger / Open API--> repo
• ApiInput, EInput (maybe other general components such as DialogBase, DialogForm) --> not sure 🤔💭 / in code docu not suffienct?

[manuelmeister]

Meeting Discussion

• [ ] Wiki:
  • [ ] Principles
  • [x] Setup
  • [x] Deployment
  • [ ] Big Picture
  • [ ] API basics including timezones and link to Swagger
  • [x] Frontend Basics
  • [x] Locale JSON structure
• [x] Repo: Swagger / Open API
• [ ] Comments on props in Vue Components
• [ ] Try to generate component types?

[carlobeltrame]

The documentation in backend/module/eCampApi/config/documentation.config.php should be updated to reflect the changes in #806 and #834.