iotaledger / documentation-platform

Legacy documentation platform
Apache License 2.0
52 stars 13 forks source link

Improve search to include page text in the search results #139

Closed jakubcech closed 5 years ago

jakubcech commented 5 years ago

Description

Right now the search we have only includes article name + link. We'd like to have a section of the text at the beginning of the 'found' page included in the results as well.

Motivation

Easier to use search, where users are given more context before opening the result page.

Requirements

  1. User searches for a term.
  2. Search result page is displayed.
  3. Each search result item contains:
    • Header + Link
    • Text from the beginning of the article.

(?) What's a good amount of text to include in search results? Standard meta description for search results on the web (Google) right now is 155–160 characters. I think that should be enough.