docs(getAlgoliaHits): rewrite guides #474
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sarahdayan
commented
Mar 2, 2021
| #### `query` | ||
|
|
||
| > `string` | required | ||
|
|
||
| The query to search for. | ||
|
|
||
| #### `params` | ||
|
|
||
| > [`SearchParameters`](https://www.algolia.com/doc/api-reference/search-api-parameters/) | required |
There was a problem hiding this comment.
Why are they required? You may not want to pass any additional parameters.
There was a problem hiding this comment.
query and params are not required actually.
sarahdayan
force-pushed
the
docs/getAlgoliaHits
branch
from
2f27e87 to
1fd550e
Compare
The Docusaurus team is aware of this problem (facebook/docusaurus#3915). |
francoischalifour
approved these changes
Mar 2, 2021
Co-authored-by: François Chalifour <[email protected]>
francoischalifour
approved these changes
Mar 3, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This rewrites the
getAlgoliaHitsdocs for bothautocomplete-preset-algoliaandalgolia-js.I wanted to move the parameters to a partial to avoid having to redirect users to
autocomplete-preset-algolia#getAlgoliaHits, unfortunately when you do that, the scrollspy doesn't pick up headings 🤦🏻♀️🤷🏻♀️