refactor: search boost and pitch trim results

Valastiri commented 3 months ago

Summary

Includes fixes to boost finding "Pitch Trim" in search results on the beginners guide.

Future Boosting Control: After this PR we should opt to establish a boosting criteria for relevant pages if we need.

Currently it is set as the following to tweak results:

boost: 2 (this is to bump desired result to the top)
boost: 1 (demote other results)
boost: 0.5 (further demote - see note below)

Header classification plays a a factor in natural boosting of results i.e. if an h1 contains trim it will most likely appear ahead of other searchs that are plain body or as a sub-heading.

TO DO

[ ] Add additional information to Pitch Trim (request from Dev's)
[ ] Check if applicable to other pitch trim related pages that are not beginners guide

Location

docs/pilots-corner/beginner-guide/engine-start-taxi.md
docs/pilots-corner/a32nx-briefing/flight-deck/pedestal/rudder-trim.md
docs/pilots-corner/a32nx-briefing/flight-deck/pedestal/thrust-pitch-trim.md

Discord username (if different from GitHub): valastiri

vercel[bot] commented 3 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 31, 2024 6:45am

Sleinmaster commented 3 months ago

As far as I understand, you only boost the whole page, no matter of the search term. In my opinion, the Beginners Guide could be boosted in general, but otherwise it very much depends on the search term and the users' intent/question, so boosting entire pages might not be ideal.

Does a boost value of 1 make sense at all? That's just the default.

Valastiri commented 2 months ago

As far as I understand, you only boost the whole page, no matter of the search term. In my opinion, the Beginners Guide could be boosted in general, but otherwise it very much depends on the search term and the users' intent/question, so boosting entire pages might not be ideal.

Does a boost value of 1 make sense at all? That's just the default.

As far as I understand, you only boost the whole page, no matter of the search term. In my opinion, the Beginners Guide could be boosted in general, but otherwise it very much depends on the search term and the users' intent/question, so boosting entire pages might not be ideal.

Does a boost value of 1 make sense at all? That's just the default.

As far as I understand, you only boost the whole page, no matter of the search term. In my opinion, the Beginners Guide could be boosted in general, but otherwise it very much depends on the search term and the users' intent/question, so boosting entire pages might not be ideal.

Does a boost value of 1 make sense at all? That's just the default.

Sorry I've been a bit busy, let's actually boost all of beginner guide to 2. Since it's primarly where the bulk of our content is. I think that should be fine overall.

I'll work on that this week. Thanks!

flybywiresim / docs