patternfly / patternfly/patternfly-org
Enhance search functionality
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 74
- Forks
- 147
- Avg merge
- 4d 11h
- Merged PRs (30d)
- 2
Description
Based on the Algolia search data, it seems like there are some potential improvements that could be made to our search functionality. Some ideas that I think are worth investigating are:
- Advanced search- there has been some talk about this in the product space, and I wonder if it would make sense here as well. Having more functionality that would allow users to navigate our documentation better through our search
- Fuzzy or soft search- there are times that people search for terms but either don't spell the components correctly, can we offer some kind of autocorrect feature or soft search for when these situations happen?
- Related terms- if a user searches something, but we have a similar idea with a different name, can we offer related terms? (i.e. they search for something that we either don't have or maybe even want to discourage so we offer another component)
- FAQ page- if a user is unable to find any results, can we offer them a FAQ page as a result to help them navigate our documentation better?
This issue is likely more of a spike as we'd have to investigate what options we have with our search functionality to know what improvements are currently possible.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the available Algolia search data and the current search functionality. Investigate the feasibility of advanced search, fuzzy matching, related terms, and FAQ results; done means documenting which improvements are possible and what further work each would require.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, search
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100