Galileo-Galilei / kedro-mlflow

A kedro-plugin for integration of mlflow capabilities inside kedro projects (especially machine learning model versioning and packaging)
https://kedro-mlflow.readthedocs.io/
Apache License 2.0
195 stars 29 forks source link

Documentation improvements #6

Closed turn1a closed 3 years ago

turn1a commented 4 years ago

A catch-all ticket to gather documentation improvement ideas.

  1. Mark code blocks in README.md's Markdown with specific language - you can use
    ```python

    or

    ```yml

    at the beginning of a code block to enable syntax highlighting.

Galileo-Galilei commented 4 years ago

Hello @kaemo, this is the next task I will be working on. I have in mind the following items (in addition to your remark):

Galileo-Galilei commented 3 years ago

Update the readme:

Galileo-Galilei commented 3 years ago

It is very common to have some broken links in the documentation. I suggest we: