Some documentation searches are giving misleading results

[TWiStErRob]

How are you running Renovate?

WhiteSource Renovate hosted app on github.com

If you're self-hosting Renovate, tell us what version of Renovate you run.

No response

Please select which platform you are using if self-hosting.

No response

If you're self-hosting Renovate, tell us what version of the platform you run.

No response

Was this something which used to work for you, and then stopped?

I never saw this working

Describe the bug

For example if you search for "depTypes":

the results show "File Matching" as the header, even though the results are pointing to specific manager documentations:

• https://docs.renovatebot.com/modules/manager/pipenv/
• https://docs.renovatebot.com/modules/manager/poetry/
• https://docs.renovatebot.com/modules/manager/npm/

I would expect "Automated Dependency Updates for Pipenv" to show instead for the first result for example.

Relevant debug logs

N/A

Have you created a minimal reproduction repository?

No reproduction, but I have linked to a public repo where it occurs

[rarkins]

For some reason it's using the first heading as the title for the page

[HonkingGoose]

The individual manager pages are absent from the nav in mkdocs.yml. Maybe this causes weirdness when a search hits one of those pages?

renovatebot.github.io/mkdocs.yml

Lines 114 to 174 in 2453ba6

	nav:
	- Home: 'index.md'
	- Getting Started:
	- 'Use Cases': 'getting-started/use-cases.md'
	- 'Running Renovate': 'getting-started/running.md'
	- 'Self-Hosting Examples': 'examples/self-hosting.md'
	- 'Installing & Onboarding': 'getting-started/installing-onboarding.md'
	- 'Private Packages': 'getting-started/private-packages.md'
	- Troubleshooting: 'troubleshooting.md'
	- Configuration:
	- 'Self-hosted': 'self-hosted-configuration.md'
	- 'Repository': 'configuration-options.md'
	- 'Presets': 'config-presets.md'
	- Key Concepts:
	- 'Dependency Dashboard': 'key-concepts/dashboard.md'
	- 'Renovate Scheduling': 'key-concepts/scheduling.md'
	- 'Automerge': 'key-concepts/automerge.md'
	- Renovate Modules:
	- 'Platforms': 'modules/platform.md'
	- 'Managers': 'modules/manager.md'
	- 'Datasources': 'modules/datasource.md'
	- 'Versioning': 'modules/versioning.md'
	- Language Support:
	- 'Bazel': 'bazel.md'
	- 'Docker': 'docker.md'
	- 'Golang': 'golang.md'
	- 'Java': 'java.md'
	- 'JavaScript': 'javascript.md'
	- 'Node.js Versions': 'node.md'
	- 'Nuget': 'nuget.md'
	- 'PHP': 'php.md'
	- 'Python': 'python.md'
	- 'Ruby': 'ruby.md'
	- Deep Dives:
	- 'Should you Pin your Javascript Dependencies?': 'dependency-pinning.md'
	- 'Config Template Editing': 'configuration-templates.md'
	- 'Updating and Rebasing Branches': 'updating-rebasing.md'
	- 'Semantic Commit Messages': 'semantic-commits.md'
	- 'Noise Reduction': 'noise-reduction.md'
	- Included Presets:
	- 'Compatibility Presets': 'presets-compatibility.md'
	- 'Default Presets': 'presets-default.md'
	- 'Docker Presets': 'presets-docker.md'
	- 'Full Config Presets': 'presets-config.md'
	- 'Group Presets': 'presets-group.md'
	- 'Helper Presets': 'presets-helpers.md'
	- 'Monorepo Presets': 'presets-monorepo.md'
	- 'npm Presets': 'presets-npm.md'
	- 'Package Presets': 'presets-packages.md'
	- 'Preview Presets': 'presets-preview.md'
	- 'Regex Manager Presets': 'presets-regexManagers.md'
	- 'Replacement Presets': 'presets-replacements.md'
	- 'Schedule Presets': 'presets-schedule.md'
	- 'Workaround Presets': 'presets-workarounds.md'
	- All Other:
	- 'Security and Permissions': 'security-and-permissions.md'
	- 'Merge Confidence': 'merge-confidence.md'
	- 'Templates': 'templates.md'
	- 'Frequently Asked Questions': 'faq.md'
	- 'Known Limitations': 'known-limitations.md'
	- About Us: 'about-us.md'

Issue #149 tracks the missing items in the nav.

---

Here are the docs for search in Material for MkDocs. I don't think there's much we can do ourselves to improve the search.

[HonkingGoose]

For some reason it's using the first heading as the title for the page

This seems to be fixed after we updated to Material for MkDocs 9 (or because of other changes). Here's a new screenshot for the depTypes search:

Overall the new search looks better, and shows more context for results.

Can't find presets via their name

I can't find the presets via the Material for MkDocs search. Steps to reproduce:

1. Go to production docs site.
2. Enter workarounds:javaLTSVersions in the search bar
3. Search bar says: "no matching documents"
4. But we do have a page with workarounds:javaLTSVersions as the heading title: https://docs.renovatebot.com/presets-workarounds/#workaroundsjavaltsversions

[viceice]

I'm closing this, as new mkdocs material is much better

[viceice]

@HonkingGoose It seemds it can't search for : 😕 You can open a new issue you think we should fix that somehow

[TWiStErRob]

Thanks for revisiting, indeed it's way better now.

[TWiStErRob]

@HonkingGoose please open another issue for search, I can confirm that search experience is pretty bad for any presets, even when trying to search just for the thing after the :. I think tokenization setup is messed up (if it's configurable)