Skip to content

search_data.json incorrect for indexing with Hex search #5083

@lpil

Description

@lpil

Back in Feb the Hex folks changed the format of the file we use for our HTML docs search, so they could index it for the new Hex search. Unfortunately the format doesn't match what their code needs, so the data we have been publishing is not usable by Hex search.

The doc field contains the documentation as HTML, but it needs to be as markdown.

We will also need to change the name of search_data.json, so they can identify the newer valid files. Perhaps search-data.json.

We need to ensure that the search in our HTML docs continues to work with this change.

I wonder if there's value in publishing 2 different JSON files, one for our search, one for theirs. This could help avoid this confusion in future.

Metadata

Metadata

Assignees

No one assigned

    Labels

    help wantedContributions encouraged

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions