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.

Sign up for GitHub

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

Jump to bottom

Update Docs for actions and how to work with this #12

Open
oke-aditya opened this issue Sep 10, 2020 · 3 comments
Open

Update Docs for actions and how to work with this #12

oke-aditya opened this issue Sep 10, 2020 · 3 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hactoberfest Issue open for hactoberfest contributorrs

Comments

@oke-aditya
Copy link
Owner

📓 Documentation

New people might not know how CI and such actions work to ease their jobs.

Also, we need to specify where people need to edit a bit properly
@oke-aditya oke-aditya added documentation Improvements or additions to documentation good first issue Good for newcomers hactoberfest Issue open for hactoberfest contributorrs labels Sep 10, 2020
@Gau02
Copy link
Contributor

Gau02 commented Oct 8, 2020

📓 Documentation

New people might not know how CI and such actions work to ease their jobs.

Also, we need to specify where people need to edit a bit properly

@oke-aditya, Do you want to create a README which instructs how to check/use/edit CI workflows present in this repository?

@oke-aditya
Copy link
Owner Author

Yes. I want documentation about how these CIs run and what they do.

@oke-aditya
Copy link
Owner Author

That readme can go via mkdocs to this website docs. It has to be md file not rst.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hactoberfest Issue open for hactoberfest contributorrs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Gau02 @oke-aditya