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

Separate the documentation from Readme file #29

Open
naman03malhotra opened this issue Nov 15, 2020 · 0 comments
Open

Separate the documentation from Readme file #29

naman03malhotra opened this issue Nov 15, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers low-hanging fruit Easy issue

Comments

@naman03malhotra
Copy link
Owner

As we keep adding more examples, we should move the documentation in a docs directory with its separate markdown file.

  • create a new directory docs.
  • create EXAMPLES.md.
  • Move examples in that file.
  • Link those examples in the main README.md file.
@naman03malhotra naman03malhotra added good first issue Good for newcomers low-hanging fruit Easy issue labels Nov 15, 2020
@naman03malhotra naman03malhotra added the documentation Improvements or additions to documentation label Feb 18, 2021
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 low-hanging fruit Easy issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@naman03malhotra