smartcontractkit/documentation

[Enhancement]: Fix Algolia search indexing

Closed this issue · 0 comments

What would you like us to improve?

To enhance Algolia search relevance, it is recommended to split records into smaller chunks.

  1. In order to index long documents with Algolia, documents have to be divided into smaller records, because there’s a record size limit for performance reasons. Currently, some Chainlink .mdx files exceed these limits.
  2. According to Algolia's documentation, it’s better to avoid indexing much content in a single record, as it degrades search relevance. Full pages contain too much text, which leads to returning irrelevant results when a user performs searches. A better approach is to create small, hierarchical objects based on the structure of the page (e.g. paragraph)

I am looking to split records into smaller chunks based on headings.

How important it is?

  1. Documents, that exceed Algolia's limits, must be reduced or split into smaller records.
  2. Splitting records into small chunks (e.g. paragraphs) improves search relevance.