Skip to content

Commit ddb0c20

Browse files
authored
Update search example with topics with white space (github#18290)
1 parent 7dc3c71 commit ddb0c20

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

contributing/search.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ To see all existing search-related issues and pull requests, visit [github.com/g
1515
## How to search
1616

1717
The site search is part of every version of docs.github.com. On any page, you can use the search box to search the documents we've indexed.
18-
You can also query our search endpoint directly at: https://docs.github.com/search?language=en&version=dotcom&query=jekyll&filters=topics:actions
18+
You can also query our search endpoint directly at: https://docs.github.com/search?version=dotcom&language=en&filters=topics:%27oauth%20apps%27+AND+topics:%27github%20apps%27&query=install
1919

20-
Using the attribute `topics` in your query will only return results that have the matching topic value. You can find a full list of topics in [the allowed topics file](/data/allowed-topics.js). The `topics` attribute is configured as a [`filter only` facet in Algolia](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
20+
Using the attribute `topics` in your query will only return results that have the matching topic value. You can find a full list of topics in [the allowed topics file](/data/allowed-topics.js). The `topics` attribute is configured as a [`filter only` facet in Algolia](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/). When the topic contains spaces, you must use quotes. For Algolia, [here](https://www.algolia.com/doc/api-reference/api-parameters/filters/#handle-attributes-with-spaces) is an example for filters containing spaces. Algolia also requires [boolean operators](https://www.algolia.com/doc/api-reference/api-parameters/filters) to combine more than one filter.
2121

2222
This endpoint responds in JSON format, and fronts Algolia and Lunr. We recommend using this endpoint over directly integrating with Algolia or Lunr, as the endpoint will be more stable.
2323

0 commit comments

Comments
 (0)