Makes Guides appear before Reference pages in search

[mcanouil]

What would you like to do?

Give feedback or suggest an improvement

Description

Is it possible to make the “reference pages” of https://quarto.org have less weight in search?

For instance, if you search for “include”, you get as first result the guide for the shortcode (that’s fine/perfect), but then you get the reference pages.
If you scroll far enough you will finally find the include- YAML option guide (mentioned in the reference pages).
https://quarto.org/docs/output-formats/html-basics.html#includes

In general, I think the guides should be exposed before the reference pages.

[cscheid]

@dragonstyle tells me that this is possible with Algolia search indices (which we use on quarto.org). But it requires access to the Algolia account, which we need to sort out.

[cderv]

But it requires access to the Algolia account, which we need to sort out.

I think @cwickham has access. Do you ? Or just my imagination ?

[cwickham]

@cderv, I do. @cscheid and I are going to take a look next time we meet.

[cwickham]

You can play with our first attempt at https://deploy-preview-1541.quarto.org

Currently, this just applies a boost to "Guide" pages, i.e. if pages score identically on Algolia's ranking criteria, Guide pages will be listed before any other pages (Reference or not).

It does a bit better with your example @mcanouil, those Guide pages now start at result 3:

There's still a Reference page as the 2nd result, and that's because of Algolia's ranking, an exact match to "Include", wins over the partial match to "Includes".

A search for "Includes" give the shortcode, then relevant Guide pages:

[mcanouil]

It seems better, I tested few cases such as:

Current	Preview

[cwickham]

I agree, the change seems to be for the better. I'll get this up and running on quarto.org.

[cwickham]

Guide pages are now promoted on quarto.org and prerelease.quarto.org