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] Move Examples to a Directory #14

Closed
1 of 3 tasks
vaguecoder opened this issue Jan 6, 2023 · 3 comments · Fixed by #33
Closed
1 of 3 tasks

[Documentation] Move Examples to a Directory #14

vaguecoder opened this issue Jan 6, 2023 · 3 comments · Fixed by #33
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@vaguecoder
Copy link
Owner

What?

Currently, all examples are on README.md making scroll forever. Need to move them to a directory examples/ with respective document names and hyperlinks, except for installation and examples (which only has 3 code blocks).

Why?

README.md too lengthy.

Additional Context

NA

Ownership of Contribution

If the triage is approved,

  • I wish to submit the PR myself.
  • I wish to submit the PR. But if someone is willing to do it, go ahead.
  • I don't know how to fix this or make these changes. I wish others to pick this up for me.
@vaguecoder vaguecoder added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jan 6, 2023
@Rishav1707
Copy link

Shall I work on this issue? @vaguecoder

@vaguecoder
Copy link
Owner Author

Can you please pick this up post the completion of #6 which might conflict? I'll assign this to you.

@tanryberdi FYI.

@vaguecoder
Copy link
Owner Author

Good job @Rishav1707 Thanks for the contribution.

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 good first issue Good for newcomers
Projects
None yet
2 participants