Docs: Search results are hard to interpret for common search terms

[IanButterworth]

For title. Repetition and lack of a singular result that appears to match well.

For scatter. I would've expected there to be a dedicated section on scatter plots?

[IanButterworth]

Also padding. The results don't seem to make sense

[BeastyBlacksmith]

For scatter and padding its just that we don't have sections for these. But I agree it would be nice, to only show the result of one example page in the results, but I don't know if you can register custom filters for the Documenter search

[t-bltg]

Seems to be a side effect of adding the new gallery JuliaPlots/PlotDocs.jl#256:

search for title:
1.25
https://docs.juliaplots.org/v1.25/search/?q=title: Number of results: 53

duplicates come from the examples.

1.27
https://docs.juliaplots.org/v1.27/search/?q=title: Number of results: 155

cc @johnnychen94 who might know how to tackle this.

[IanButterworth]

Also note that the backend contexts on the search results are lost on 1.27

[johnnychen94]

I don't know if there's a way to tell Documenter to exclude certain folders from indexing. But as a workaround, we can separate the PlotDocs.jl into two repositories (the main doc and the gallery doc) and two Documenter builds.

• main doc: https://docs.juliaplots.org/v1.27
• gallery doc: https://docs.juliaplots.org/gallery/v1.27

with link https://docs.juliaplots.org/v1.27/gallery points to https://docs.juliaplots.org/gallery/v1.27. By doing this, contents from the gallery doc will be automatically excluded when searching the main doc.

[BeastyBlacksmith]

That would result in getting no results for examples at all, no?

[johnnychen94]

It is for the main doc, but you can still search the demos in the gallery doc. But TBH, I don't think it's more useful than a plain "Ctrl-F" search in the gallery doc.

[t-bltg]

For a beginner, it's mandatory to be able to land on the examples when issuing a search. IMO, splitting into 2 docs is only going to increase complexity.

[IanButterworth]

As an aside, if it helps, for julia base docs, google analytics was used to figure out the common search terms that need good search results. It might be worth doing something similar to aid typical users searches, which are hard to gauge when you're a package developer IMO