← Back to issue list

docs: searching for build-packages yields no useful results

View original Github issue

Metadata

Project
snapcraft
Number
#6046
Type
issue
State
open
Author
zyga
Labels
Type: Bug Type: Documentation Type: Research
Created
Updated
Closed

Current evaluation

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.

Suggested action: keep open

Reason: Maintainer @medubelko triaged the issue, confirmed the root cause (Sphinx default search doesn't prioritise section names and splits 'build-packages' into two terms), and explicitly deferred the fix to a planned theme migration with a different search provider 'later this year.' The issue is acknowledged, scoped, and waiting on an external dependency (the migration), so it should remain open.

Impact: 25 Quick Win: 13.75 Staleness: 50 Complexity: 45 Confidence: 75 Support Request: 10

Issue body

*Please describe the question or issue you're facing with "Contribute to this documentation - Snapcraft documentation".* Follow https://documentation.ubuntu.com/snapcraft/latest/search/?q=build-packages&check_keywords=yes&area=default and observe lack of relevant documentation for a syntax element. Moreover the syntax belongs under parts, yet is not found anywhere. --- *Reported from: https://documentation.ubuntu.com/snapcraft/latest/contribute-to-this-documentation/*

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 25
Quick Win: 13.75
Staleness: 50
Complexity: 45
Confidence: 75
Support Request: 10
keep 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.
qwen/qwen3.6-35b-a3b
Staleness: 40
Complexity: 20
Confidence: 85
Support Request: 10
keep open Documentation search for build-packages returns poor results due to Sphinx tokenization. A maintainer identified the root cause and deferred resolution to a planned search provider migration later this year.
qwen3.6-35b-a3b-mtp-q6
Staleness: 45
Complexity: 20
Confidence: 85
Support Request: 0
keep open Documentation search fails to surface build-packages due to Sphinx tokenization treating it as two words. Maintainer acknowledged limitation and deferred fix to future search provider migration.
qwen3.6-35b-a3b-mtp-q6
Staleness: 45
Complexity: 25
Confidence: 80
Support Request: 10
keep open Sphinx search splits hyphenated terms like build-packages into separate words, burying relevant docs. Acknowledged as a current limitation, resolution is deferred until the planned migration to a new search provider later this year.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#6099 docs: improve discoverability of the build-packages key snapcraft closed 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.
75%