← Back to issue list

docs: improve discoverability of the build-packages key

View original Github issue

Metadata

Project
snapcraft
Number
#6099
Type
pull request
State
closed
Author
gcomneno
Labels
Created
Updated
Closed

Current evaluation

Closed without merging. Proposed doc changes failed to improve search discoverability and disrupted existing content. Sphinx search treats hyphenated terms as separate words. Will be reassessed after migrating to a new search provider.

Suggested action:

No scores available.

Issue body

Improve discoverability of the `build-packages` key by adding a dedicated section in the dependency management documentation. This makes the key easier to locate through documentation search. Fixes #6046.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Closed without merging. Proposed doc changes failed to improve search discoverability and disrupted existing content. Sphinx search treats hyphenated terms as separate words. Will be reassessed after migrating to a new search provider.
qwen3.6-35b-a3b-mtp-q6 Closed without merging. Docs changes failed to improve search discoverability as Sphinx treats hyphenated terms as separate words. Maintainers closed the PR, noting the search limitation will be reassessed after a future theme migration.
qwen3.6-35b-a3b-mtp-q6 Closed. Proposed doc changes failed to improve search discoverability and disrupted existing content. Sphinx's fuzzy search splits hyphenated terms. The issue will be reassessed after migrating to a new search provider later this year.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#6046 docs: searching for build-packages yields no useful results snapcraft open Snapcraft docs search for 'build-packages' returns poor results due to Sphinx default search treating hyphenated terms as separate words. Maintainer triaged, identified root cause, and deferred fix to a planned theme/search-provider migration.
75%