[workspace] Documentation

[ascariandrea]

To address properly the new documentation development and creation we need to put down a list of needed elements and find a good strategy to present our docs.

Here are the "projects" we're gonna document in the near future:

• [ ] packages
  • [ ] shared
    • [ ] providers
  • [ ] taboule
• [ ] yttrex
  • [ ] api
  • [x] extension
• [ ] tktrex
  • [ ] api
  • [x] extension
• [ ] guardoni
  • [x] cli
  • [x] electron
• [ ] ycai
• [ ] extension
• [ ] api

And for each project I would like to have at least:

• [ ] a general section with
  • [ ] 1 download button if is something the user can download
  • [ ] 1 screenshot (unless is the Open API documentation for backend api)
• [ ] a "usage" section
• [ ] 1 example for the most important features
• [ ] option/configuration chapter
• [ ] a "development" section
• [ ] run the project for development
• [ ] build the project yourself

We also have a lot of concept that are shared among the packages and the platforms - i.e. the usage of io-ts, dotenv, the concept of endpoints, the webpack configuration and so on - that needs to be introduced in the first chapter of the documentation, to let user better understand how our codebase works. Here's a incomplete list of additional reference and explanation we need to add:

• [ ] repo structure and commands logic
• [ ] puppeteer
• [ ] fp-ts and io-ts
• [ ] a paragraph on how endpoints works
• [ ] a paragraph on our opinionated webpack config
• [ ] test
  • [ ] fast-check

I'm gonna setup docusaurus to implement the structure mentioned above, and then we can start writing the documentation :)

[vecna]

please note, I merged in daily the pull request; I'll start to test the sync with online website