Add more documentation and notebooks

[sinnec]

Edit: This PR brings the following changes:

• Chnages color to whitebox turquoise.
• (Probably) Fixes link references.
• Adds example notebooks
• Additions to docs and README
• Refactoring

I'll add more markdown text, but how does it seem as a first iteration?

[NickNtamp]

@sinnec I made a quick review.
First of all seems that the installation of mkdocs-jupyter is necessary. In my case this worked only with conda and not with pip.
Also I believe that there is a lot of pending work in the notebook. We have to enhance it with comments and markdown cells in order to be self-explainable. I can help you on this if you wish!!!!

[sinnec]

@NickNtamp Weird because I used pip to install it. Do you believe we could combine the SDK documentation with the notebook, because their content is almost identical?

[NickNtamp]

@NickNtamp Weird because I used pip to install it. Do you believe we could combine the SDK documentation with the notebook, because their content is almost identical?

As it is the 1st iteration, seems fine for me.

[stavrostheocharis]

I also validate that had to install the "mkdocs-jupyter" in order to run it.

To tell you the truth I don not like very much as it is depicted as notebook inside the docs (just personal view).
Maybe if we could include the notebooks inside the repo and reference them inside the docs?
They do something similar in mlflow docs:

And maybe just have the code in a table as depicted below? (also to mention somewhere "Python")

[sinnec]

@stavrostheocharis Well, the code exists in the "Using Whitebox" section and the descriptions provided are more detailed than some comments. It's almost identical (at least the one I made). I don't reject that thought of just referencing the notebooks, also given the fact that they look kinda ugly in the docs. Not all markdown can be applied on them. I made a sample one if you ewant to check out and we can decide on what we want to do and continue with that.

I personally prefer a folder with notebooks that's dettached from the docs. Your thoughts @NickNtamp @momegas ?

[sinnec]

See the sections "Using Whitebox" and the mispelled "Notebooks/Usaging Whitebox" under the tutorial section. They tell the same story but one looks uglier!

[NickNtamp]

@stavrostheocharis Well, the code exists in the "Using Whitebox" section and the descriptions provided are more detailed than some comments. It's almost identical (at least the one I made). I don't reject that thought of just referencing the notebooks, also given the fact that they look kinda ugly in the docs. Not all markdown can be applied on them. I made a sample one if you ewant to check out and we can decide on what we want to do and continue with that.

I personally prefer a folder with notebooks that's dettached from the docs. Your thoughts @NickNtamp @momegas ?

As it is a first iteration i like it @sinnec. The only bizarre thing is that, ok...we do this for what reason? I mean we create a model, load a training and inference dataset and then what? I think that we have to give something at the end (e.g. use the UI, go to page http... etc.)

[NickNtamp]

Very good work @sinnec . Some links are missing, especially in metrics etc but I can fill them, working in the other PR for the regression models. Ok from my side.

[sinnec]

I know that there are missing links. After the doc's restructure I didn't know where they should point and since I don't know if they will work, I omitted them. 😊