✨ Search Enhancement - Enable Content Search

[GordonBeeming]

Requested by: @GordonBeeming via YakShaver.ai 🦬
cc: @GordonBeeming, @adamcogan, @tiagov8

Hi Team!

  🟥  Watch the video (38 sec)

  Url from screen share: https://www.ssw.com.au/rules

Pain

Enhance the search functionality on the Rules (Content) site to include searching within the content of the rules, not just the titles.

Acceptance Criteria

1. The search functionality should return results based on keywords found in the body content of the rules.
2. Users should be able to find rules by searching for terms that appear in the content, even if those terms are not in the title.
3. The search results should display relevant rules where the searched term appears in the content.

Screenshot

Figure: Search function only searches titles, not content

[PothieuG]

🚧 Done - PR need to be reviewed and merge though - #2544

I had to update Algolia index with content of the page (not only title as it was before).
I had to limit the content size so it would fit within the indexing JSON file's size limit due to limitation of our Algolia free plan.
Most of the content for each file are in it though, but for very large rule, we could have a limitation

Is that an option to update our Algolia plan ?

Figure: now the search is looking for content and also put some highlights

[Aibono1225]

As per my conversation with @Marxoz , let's check what the SSW.Website is using before we make decisions on Algolia

[PothieuG]

I've investigated in tina.io website and SSW.Website to check how the search functionallity are doing:

• We are also using Algolia search from what I understood:

  • Search service: https://github.com/tinacms/tina.io/blob/main/utils/new-search.tsx
  • Indexing script runned at build time: https://github.com/tinacms/tina.io/blob/main/indices/createIndices.ts

• The search feature in SSW.Website is different: the search redirect the user to a google page with a ssw filter.
  E.g site:https://www.ssw.com.au .net

So in the end we have 3 options:

1. (Recommanded) Leave as it is - Algolia free plan with truncated content
2. Upgrade Algolia
3. Google search with filter

[PothieuG]

As per our conversation during our Sprint Review:

• I will add stats about how many rules are truncated
• Estimate the cost if moving to an Algolia paid plan

[PothieuG]

Analyzed all 3,754 rules with full Markdown body content included in Algolia records.

• Average record size: 3.38 KB (well under 10 KB limit)
• Largest record: 34.44 KB (under 100 KB hard cap)
• 71 rules (1.9%) exceed 10 KB individually — this is a problem on the free Build plan which has a hard 10 KB per-record cap
• Free plan won't work — those 71 rules would be rejected. Need to upgrade to Grow plan.

Grow plan cost with ~15.6K searches/month:

Records: $0 (3,754 of 100K included)
Search requests: (15,600 (checked on Algolia dashboard) − 10,000) / 1,000 × $0.40 = ~$2.80/month

Conclusion: on Grow plan for ~$3/month.

Algolia pricing table: https://www.algolia.com/pricing