:memo: [devinterp] setting up mkdocs

[madvid]

Description

The goal is to set up mkdocs for this repository. mkdocs is a static site generator to build project documentation. The power of mkdocs is that the documentation pages are generated from Markdown, sources (which is widely used) and the settings is rather simple ( a single YAML file. More other some components of the documentation can be automatically generated based on the classes and methods docstrings.

Objective

create a static documentation site with mkdocs

Example

random example by looking for mkdocs.yml on github: https://docs.agpt.co/

Acceptance Criteria

• [ ] user can access to documentation via generated doc url

Definition of Done

• [ ] validation of the issue (by any of the repo owner I guess)
• [ ] settings completed
• [ ] migration of the existing docs (linked to the issues #41 & #35)

[svwingerden]

Basic documentation is now done. There is plenty more to do (and feel free to create another issue if you have specific suggestions), but I'm closing this for now