-
Notifications
You must be signed in to change notification settings - Fork 64
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