comic/grand-challenge.org

Search results in FAQ are hard to find

Opened this issue · 2 comments

Describe the bug
The documentation page has a search function, listing all occurences of a certain search term. If an occurence is placed in a collapsed section (such as the FAQ), the link to the search result only opens the relevant page.

To Reproduce
Steps to reproduce the behavior:

  1. Go to 'https://grand-challenge.org/documentation/'
  2. In the search textbox type simpleITK, enter
  3. Clcik on the F.A.Q. result
  4. The F.A.Q. page opens, but it does not show the relevant FAQ.

Expected behavior
The relevant FAQ should be expanded.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

  • OS: [e.g. iOS]
  • Browser [e.g. chrome, safari]
  • Version [e.g. 22]

Smartphone (please complete the following information):

  • Device: [e.g. iPhone6]
  • OS: [e.g. iOS8.1]
  • Browser [e.g. stock browser, safari]
  • Version [e.g. 22]

Additional context
Add any other context about the problem here.

See also #3575.

In the search textbox type simpleITK, enter

Note that this is case sensitive - I don't think that search should be.

The FAQ is a documentation page where the answers are hidden behind bootstrap drop-downs. There is nothing special about the FAQ page. The solutions I could see would be:

  • Having some JS that is applied to all documentation pages that highlights key terms, expanding (arbitrary) bootstrap elements as needed.
  • Making the FAQ a first-class application as a sort of knowledge base on the site. That would make it helpful for answering and linking to common customer queries. Would also help with highlighting this as I didn't even realise we had an FAQ.

I think both would require a pitch as I cannot see a quick way to implement this feature request.

Would also help with highlighting this as I didn't even realise we had an FAQ.

In the corner of the dark basement that is the documentation...