search

open-policy-agent / opa

Open Policy Agent (OPA) is an open source, general-purpose policy engine.
https://www.openpolicyagent.org
Apache License 2.0
9.61k stars 1.33k forks source link

Docs search doesn't include top level ToC entries in results #2244

Open patrick-east opened 4 years ago

patrick-east commented 4 years ago

Expected Behavior

If I search for "Kubernetes" in the search bar on https://www.openpolicyagent.org/docs/latest/ I would like to see the "intro" for the "KUBERNETES" ToC entry like https://www.openpolicyagent.org/docs/latest/kubernetes-introduction/

Actual Behavior

Instead I get links for things mid-way through that section of the docs:

image

That first entry of "Kubernetes" goes to image

Additional Info

This might require some tweaking for the generated HTML content as well as potentially the configuration in https://github.com/algolia/docsearch-configs/blob/master/configs/openpolicyagent.json to get those top level toc sections to be searchable.

A maybe more simple thing would be to make each of those sections we want searchable to have a like top level intro page with a big ol <h1> header with the name.

stale[bot] commented 2 years ago

This issue has been automatically marked as inactive because it has not had any activity in the last 30 days.