trufflesuite / trufflesuite.com

Trufflesuite website source ✨
https://trufflesuite.com
182 stars 421 forks source link

Search fails to find some relevant and expected results. #604

Open wbt opened 4 years ago

wbt commented 4 years ago

Steps to reproduce:

  1. Visit https://www.trufflesuite.com/docs/truffle/overview
  2. In the search box, type "geth"
  3. Find just two results:
    • Drizzle | Drizzle Quickstart (Install Drizzle via npm...)
    • Truffle | Truffle Commands (This section will describe every command available in the Truffle application...)
  4. Manually review documentation to do a reading search and find additional results that were not included, such as
  5. Searching in this repo, it appears that the correct number of search results is 4-5.

It is unknown how many other terms have incomplete search results.

However, it does not appear that there is an error processing the search term, because the number of results is >0. It just looks like the indexing needs improvement!

Looking at the source markdown files, the third and fourth of the bulleted results above have the same casing, spelling, and formatting, so that does not appear to be the cause.

OnlyOneJMJQ commented 4 years ago

Hi @wbt! Thank you for this detailed write-up. Our search functionality isn't ideal at the moment, but we're currently exploring alternate documentation platforms to support versioning and better search resolution. I'll keep this open for now so we can have it as a reference test.