Closed andydandy74 closed 7 years ago
Thanks @andydandy74 great suggestions.
Constrain search to certain categories (classes, methods, properties)
Will add to backlog
- Make search available on the landing page (perhaps move the search field into the page header?)
Will add to backlog. I would think people usually target a specific API when they search. Maybe a text input with a filter dropdown filter for api year would work. See # 2
- Show search results as a new page
New search features will trigger re-thinking the search backend and UI. I will keep this in mind.
- Show more context in search results (e.g. if result is a property show the name of the class, too)
Will add. Need to think about how to implement
Most of these improvments (except #2) require backend changes. This was in my roadmap for 2.0: I need to create my own index of all pages in a DB (extract article type, namespace, etc) so I can query/filter/list by those parameters efficiently
Currently search only searches for article name from a json that stores the namespace tree, which is fast but limited https://raw.githubusercontent.com/gtalarico/revitapidocs/master/app/templates/json/ns_2015.json
In the meantime if you need better search, you can use the public Google Custom Search Engine: https://cse.google.com/cse/publicurl?cx=014747897160299638528:fxtbgkrsxas
Split into issues #42 #43 #43 #44
Commit 378a17bf0b3f76584703777a7ebf937fa1635972 now saves scroll location and filter for search results
Having worked with revitapidocs.com for a while now, here are some ideas of how the search UX could be improved: