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

Add new top level search page #1099

Closed
coke opened this issue Jan 1, 2017 · 9 comments
Closed

Add new top level search page #1099

coke opened this issue Jan 1, 2017 · 9 comments
Assignees
Labels
wishlist "nice to have" issues; might require a lot of work or a big change or be low priority

Comments

@coke
Copy link
Collaborator

coke commented Jan 1, 2017

Add a new top level index/search page.

  • Display every category/item currently available in the existing search box.
  • Categories ordered by either a hardcoded ranking, or alphabetically.
  • Within a section, items are ordered alphabetically.
  • Provide a search box separate from the existing search, which has the result of hiding the links that do not match.
  • Should be able to link to this page and pass in a search string - when loading the page, show the string in the search box and perform the search. (preferably before loading the page).

Once this is in place, we can start making the dropdown search a little smarter and link to this as a fallback when users want to see all possible search results.

We may also want to make it a top level link in the docs menu.

@JJ
Copy link
Contributor

JJ commented Apr 28, 2018

Are we still interested in this?

@coke
Copy link
Collaborator Author

coke commented Apr 28, 2018

Yes

@JJ JJ removed the JJ TPF Grant label May 14, 2018
@JJ
Copy link
Contributor

JJ commented May 27, 2018

I think #1410 is kind of a blocker to this one. Search categories, for the time being, are LTA.

@JJ JJ added the wishlist "nice to have" issues; might require a lot of work or a big change or be low priority label Jun 7, 2018
@coke coke removed their assignment Sep 27, 2019
@Altai-man Altai-man self-assigned this Nov 7, 2020
@coke
Copy link
Collaborator Author

coke commented Nov 17, 2020

So, this was about 4 years ago, so let me see if I can remember what I was thinking. This was intended as a top level static page - a dynamic search page could probably be done cleaner.

Display every category/item currently available in the existing search box.

I imagined the categories as headers, with a list of items below. In retrospect, I suspect having all the items visible would just be too cluttered. (but you could have them present if a partial search was present)

Provide a search box separate from the existing search, which has the result of hiding the links that do not match.

Ah. so if we do show all the links by default, as you start typing, hide those that don't match.

Should be able to link to this page and pass in a search string - when loading the page, show the string in the search box and perform the search. (preferably before loading the page).

This'd be a little tricky but should be doable with some javascript.

... If you're working on this, please consider these suggestions for the UI, but not gospel.

@MorayJ
Copy link
Contributor

MorayJ commented Mar 2, 2021

I'm not clear if this is intended as a full page search, a headline and first paragraph search or just a headline search that has a first para in the results. Any thoughts?

@Altai-man
Copy link
Member

I think it describes a separate page (with url say /search) with a big nice input where user types queries and gets results based on the index entries we already have.

So it uses the same data the search in the header users, just presents it more clearly and allows goodies like connecting search engines.

Maybe I misunderstood your question, can you please clarify with examples of what you think about?

@MorayJ
Copy link
Contributor

MorayJ commented Mar 2, 2021

That's pretty much what I was querying, I think. The example page has extra text but, from a search point of view, I guess this is cosmetic and gives more information on what you've found. Thanks

@Altai-man
Copy link
Member

For now let's omit the detailed text in a result item (so, leaving only the headlines).

@coke
Copy link
Collaborator Author

coke commented Feb 3, 2023

This is available as part of raku/doc-website - in the header nav, select "Extended Search".

@coke coke closed this as completed Feb 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
wishlist "nice to have" issues; might require a lot of work or a big change or be low priority
Projects
None yet
Development

No branches or pull requests

4 participants