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

Need Documentation Help #2

Open
eitozx opened this issue Oct 1, 2022 · 4 comments
Open

Need Documentation Help #2

eitozx opened this issue Oct 1, 2022 · 4 comments
Labels
documentation Improvements or additions to documentation hacktoberfest-accepted For PRs that are suppose to count towards hacktoberfest

Comments

@eitozx
Copy link
Owner

eitozx commented Oct 1, 2022

It would be nice if someone can write description of all the classes in such a way that it can easily integrate with readthedocs.
@nishtha53
Copy link

nishtha53 commented Oct 1, 2022 •
edited
Loading

I can write documentation. Please share information

@eitozx
Copy link
Owner Author

eitozx commented Oct 1, 2022

@nishtha53 I believe that you're familiar with classes & methods. So just take reference of https://docs.animu.ml/ as I've tried to make it as similar as possible. In case of any doubt, feel free to ask here or on discord

@eitozx eitozx added documentation Improvements or additions to documentation hacktoberfest-accepted For PRs that are suppose to count towards hacktoberfest and removed hacktoberfest-accepted For PRs that are suppose to count towards hacktoberfest labels Oct 1, 2022
@Abhidongre
Copy link

Hi , Abhishek Dongre. I am ready to contribute to this documentation on classes and methods. Can you plz tell me what will I have to do in detail as I am newbie to hacktoberfest

@eitozx eitozx added the hacktoberfest-accepted For PRs that are suppose to count towards hacktoberfest label Oct 2, 2022
@eitozx
Copy link
Owner Author

eitozx commented Oct 2, 2022

@Abhidongre , being newbie to hacktoberfest & being newbie to documentation are two different things, where do you exactly need help?
And in order to contribute docs just take reference of https://docs.animu.ml/ as I've tried to make it as similar as possible.

@eitozx eitozx pinned this issue Oct 2, 2022
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 hacktoberfest-accepted For PRs that are suppose to count towards hacktoberfest
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@nishtha53 @eitozx @Abhidongre