Skip to content

Algo info from README.md Popups added#60

Open
AnkitaKhurana wants to merge 2 commits into
OpenGenus:masterfrom
AnkitaKhurana:Algo_info
Open

Algo info from README.md Popups added#60
AnkitaKhurana wants to merge 2 commits into
OpenGenus:masterfrom
AnkitaKhurana:Algo_info

Conversation

@AnkitaKhurana
Copy link
Copy Markdown
Member

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 #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:

image
Know More Button

image
README.md Information

image
No README.md Handling

@AdiChat
Copy link
Copy Markdown
Member

AdiChat commented Mar 2, 2018

Nice work 👍

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 readmes 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 readmes are well supported or we move to another alternative. 👍

@AnkitaKhurana
Copy link
Copy Markdown
Member Author

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: #75

This will help quark complete some part of the documentation as well.

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.

2 participants