Update dodumentation

[marcosschroh]

I would like to update the documentation and make it more clear. I would like to use markdown and publish the documentation in github pages. For example: https://marcosschroh.github.io/dataclasses-avroschema/

[tarbaig]

There are a few bugs in the documentation. What would be the correct place to fix those as a contribution to this issue?

[marcosschroh]

I am working in the new doc, I think at the end of this week will we available. After that you can send your PR

[mozcelebi]

any update on the documentation?

[tarbaig]

How is the status of the new doc? We keep finding hidden features in the code that could benefit from being public knowledge.
Currently they just go into our internal wiki.

[marcosschroh]

I was working on this one in order to use github pages. Unfortunately, for personal issues I stopped. I can push the branch that I was working and someone can continue the work.

Here is the diff: https://github.com/faust-streaming/faust/compare/feature/mkdocs-documentation?expand=1

There are some files that still they needs to be migrated from rst to md. The final step is to update the CI in order to publish the documentation

[tarbaig]

I can't promise I'll have time to do it, but if you push ( and maybe add a few remarks about missing work) I'll attempt to fit it into my schedule.

[taybin]

@marcosschroh Any update?