quark
quark copied to clipboard
Algo info from README.md Popups added
Fixes issue: #37
Changes: Note: A 'Know More' button was added instead of making Header clickable keeping in mind the other Pull Request and issues #47 and https://github.com/OpenGenus/quark/pull/58
- "Know More" button added in end of all Algorithms Sections
- Modal Popups to show Algo information from README.md in respective directories
- Error Message in absence of a README.md
Screenshots of the same:
Know More Button
README.md Information
No README.md Handling
Nice work :+1:
Providing an explanation for a search result will improve the learning experience and by fetching the data from the corresponding readme, it is achieving its purpose. Though as most of the readme
s are not well developed, this feature provides no result for most of the search results.
Having a Know more
button but not providing appropriate information for most of the results will degrade the user experience. Keeping this in mind, we must keep this feature on hold until readme
s are well supported or we move to another alternative. :+1:
An alternative to this could be updating information while the user is online, but that change requires more background tasks first, also collecting what information and from where to get the same is an issue.
So I have made an issue for the contributors to help us update the README files quickly: https://github.com/OpenGenus/quark/issues/75
This will help quark complete some part of the documentation as well.