Repository navigation
Expose more site data to the 'Quick Navigation' feature #969
Description
Feature Name
Quick Navigation Improvements
Description
the utility of the existing 'quick navigation' feature (the search experience you get when you press / on the site) would be improved if more data was accessible to it. e.g. the contents of individual pages (or some reasonable subset thereof, such as section headings, etc).
Motivation
today, the 'swift book' website uses this functionality and when you open the quick navigation modal, the search placeholder text says:
Search symbols in The Swift Programming Language
this suggests 'symbols' from the entire book are searchable from this UI. however, the symbols that are actually searchable are those present in the index.json file, which, for this use case, is a tiny fraction of all the things that one might wish to search for via this mechanism. ideally as much useful index data as possible could be made accessible to the 'quick navigation' feature, to make it more useful in locating relevant documentation.
related forum post: https://forums.swift.org/t/how-is-the-search-feature-of-the-generated-documentation-sites-supposed-to-work/82442
Importance
No response
Alternatives Considered
No response
Activity
czechboy0 commentedon Nov 1, 2025
Big +1, I also find myself trying and failing to use quick search to actually find content. If full text search is too much, adding at least all headings would be an improvement. But ultimately, it'd be great to have fulltext search.
It'd help motivate maintainers to write more docs if users could successfully find them.