search

mlinfra-io / mlinfra

deploy ML Infrastructure and MLOps tooling anywhere quickly and with best practices with a single command
https://mlinfra.io/
Apache License 2.0
100 stars 16 forks source link

[Documentation]: Update examples page #101

Open aliabbasjaffri opened 1 month ago

aliabbasjaffri commented 1 month ago

Describe the documentation change

Currently the documentation hosted on mlinfra.io is rather plain and bland, especially the examples section. The example section needs to be updated to be more engaging and gives a wider perspective of the utility of the tool.

Importance of the change

The examples section needs to be updated in a way that it provides user with much better experience of what the example does and how can they possibly build stack of their own and run it using mlinfra

Additional context

No response

Moses-Mk commented 1 month ago

Please assign me this task, I am a first time opensource contribute and this is within my grasp

aliabbasjaffri commented 1 month ago

Hey @Moses-Mk! Assigning the task to you. Don't hesitate to ask anything and good luck :-)

spyingcyclops commented 5 days ago

Hi @aliabbasjaffri - is this issue in progress? If not, I'd be interested in contributing on this project.

aliabbasjaffri commented 15 hours ago

Hey @spyingcyclops you're most welcome to pick any other task, i'm in the process of revamping docs, and will be taking care of this too.

spyingcyclops commented 14 hours ago

Hi @aliabbasjaffri, thanks, my main skillset is tech writing, so I was mainly looking for doc tasks to gain experience with git and oss.

Good luck with the revamp and LMK if I can help.

aliabbasjaffri commented 12 hours ago

Thank you so much! I will be opening up a few tasks regarding documentation and will tag you for your interest there.