Skip to content

Contextual doc version search (Algolia/DocSearch) #3396

@slorber

Description

@slorber

🚀 Feature

A site can be versioned. In such case it's likely we want to use an Algolia DocSearch facet filter so that we don't end up with duplicate results:

    algolia: {
      apiKey: 'x',
      indexName: 'y',
      searchParameters: {
        facetFilters: [`version:${versions[0]}`],
      },
    },

This works, but also has some drawbacks: if you are currently browsing v1, and last version is v2, when you search, you will find v2 results.

We should make this facetting behavior contextual/dynamic, instead of being hardcoded in the site config, and if user is currently browsing v1, we should facet on v1, show him v1 related results.


Note: the solution must play well with docs multi-instance support. If you have:

  • Android SDK in version v1, v2, v3
  • iOS SDK in version v4, v5, v6

What should happen if:

  • you type some Android related keyword while you are browsing iOS doc?
  • you are not browsing any doc at all (ie you are on the homepage, the blog?)

Metadata

Metadata

Assignees

No one assigned

    Labels

    featureThis is not a bug or issue with Docusausus, per se. It is a feature request for the future.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions