Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation]: Update examples page #101

Open
aliabbasjaffri opened this issue Oct 3, 2024 · 6 comments
Open

[Documentation]: Update examples page #101

aliabbasjaffri opened this issue Oct 3, 2024 · 6 comments
Labels
documentation Improvements or additions to documentation

Comments

@aliabbasjaffri
Copy link
Collaborator

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

@aliabbasjaffri aliabbasjaffri added documentation Improvements or additions to documentation hacktoberfest Issues with this label are dedicated for the Hacktoberfest time. labels Oct 3, 2024
@Moses-Mk
Copy link

Moses-Mk commented Oct 9, 2024

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

@aliabbasjaffri
Copy link
Collaborator Author

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

@spyingcyclops
Copy link

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

@aliabbasjaffri aliabbasjaffri removed the hacktoberfest Issues with this label are dedicated for the Hacktoberfest time. label Nov 23, 2024
@aliabbasjaffri
Copy link
Collaborator Author

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
Copy link

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
Copy link
Collaborator Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants