api-scenario icon indicating copy to clipboard operation
api-scenario copied to clipboard

Split the doc and use mkdocs

Open thomaspoignant opened this issue 4 years ago • 1 comments

Motivation

Currently, the readme is a bit hard to read because there is too much information on a single page.

Requirements

I think we should split the readme into multiple files and create a mkdocs site to display it correctly. I think we should use the material theme which is really great. We could deploy this site as GitHub Pages.

thomaspoignant avatar Jun 16 '20 15:06 thomaspoignant

@aftouh what do you think about that?

thomaspoignant avatar Jun 16 '20 15:06 thomaspoignant