docs(preset): update preset configuration documentation for search API #261
Conversation
- Modify example to show single-search preset structure - Add tip section explaining multi-search preset option - Recommend using single-search presets for flexibility - Update code examples in JavaScript, Dart, and Shell
docs-site/content/27.0/api/search.md
Outdated
|
|
||
| It's generally recommended to use single-search presets for flexibility. You can then combine them in a multi-search request using the `preset` parameter. | ||
| ::: | ||
|
|
||
| You can use the preset configuration for a `GET .../search` end-point as well. | ||
|
|
||
| The only requirement is that for |
There was a problem hiding this comment.
@tharropoulos This part now conflicts with some information in the changes above. Could you edit this as needed? Or may be even delete it if not needed, with the new information above?
There was a problem hiding this comment.
Deleting this section altogether at 9ae2277
There was a problem hiding this comment.
Looks like GitHub is not rendering my comment against the right line in this PR view.
My comment was about the following paragraph, not the one you deleted in 9ae2277. (Let's add that back in).
There was a problem hiding this comment.
Is 235aaad resolving this?
|
Changes need to be now made on 27.1 docs as well. While we are at this, can you please document |
Is the UPDATE: I've created a PR for it on #267 |
Remove the paragraph following the new documentation updates, as it was reiterating the same ideas.
There was a problem hiding this comment.
@tharropoulos The v27.1 content is still not fully in sync with 27.0.
I still see this for eg, in v27.1:
Change Summary
The documentation showed a default preset example for multi search presets. This PR addressed it and adds tip section to inform users about multi search presets.
Changes
PR Checklist