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

Doc/faq #241

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from
Open

Conversation

HelloSniperMonkey
Copy link
Contributor

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

Type of change

  • Documentation update

Checklist:

  • I have made corresponding changes to the documentation

Maintainer Checklist

@HelloSniperMonkey
Copy link
Contributor Author

can you please review ? @mdmohsin7

Copy link
Collaborator

@mdmohsin7 mdmohsin7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's move all the media and files related to documentation to a new folder named docs maybe. And also lets cleanup the main readme file and move the setup steps to a separate md file in the docs folder. the main readme file should only reference the guides present in docs folder

@HelloSniperMonkey
Copy link
Contributor Author

@mdmohsin7 i have done the things you have suggested please merge this PR at your convenient time

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

Successfully merging this pull request may close these issues.

DOC: Restructure Documentation and Cleanup README with new FAQ section added
2 participants