docs(getAlgoliaResults): rewrite guides (#475)

* docs(autocomplete-preset-algolia): add common note

* docs(getAlgoliaResults): rewrite guides

* docs(getAlgoliaResults): fix intro

* docs(getAlgoliaResults): fix page

* docs(getAlgoliaResults): small fixes

* fix: apply suggestions from code review

Co-authored-by: François Chalifour <[email protected]>

Co-authored-by: François Chalifour <[email protected]>

Author: sarahdayan

packages/website/docs/getAlgoliaResults-js.md

@@ -3,15 +3,22 @@ id: getAlgoliaResults-js
 title: getAlgoliaResults
 ---
 
-Retrieves Algolia results from multiple indices.
+import GetAlgoliaResultsIntro from './partials/preset-algolia/getAlgoliaResults/intro.md'
+
+<GetAlgoliaResultsIntro />
 
 ## Example
 
+This example uses the function along with the [`algoliasearch`](https://www.npmjs.com/package/algoliasearch) API client.
+
 ```js
 import { getAlgoliaResults } from '@algolia/autocomplete-js';
 import algoliasearch from 'algoliasearch/lite';
 
-const searchClient = algoliasearch(APP_ID, SEARCH_API_KEY);
+const searchClient = algoliasearch(
+  'latency',
+  '6be0576ff61c053d5f9a3225e2a90f76'
+);
 
 getAlgoliaResults({
   searchClient,
@@ -29,6 +36,6 @@ getAlgoliaResults({
 });
 ```
 
-## Params
+## Parameters
 
-See [`autocomplete-preset-algolia#getAlgoliaResults`](getAlgoliaResults#params).
+See [`autocomplete-preset-algolia#getAlgoliaResults`](getAlgoliaResults#parameters).

packages/website/docs/getAlgoliaResults.md

@@ -2,15 +2,47 @@
 id: getAlgoliaResults
 ---
 
-Retrieves Algolia results from multiple indices.
+import GetAlgoliaResultsIntro from './partials/preset-algolia/getAlgoliaResults/intro.md'
+import PresetAlgoliaNote from './partials/preset-algolia/note.md'
+
+<GetAlgoliaResultsIntro />
+
+<PresetAlgoliaNote />
+
+## Installation
+
+First, you need to install the preset.
+
+```bash
+yarn add @algolia/autocomplete-preset-algolia@alpha
+# or
+npm install @algolia/autocomplete-preset-algolia@alpha
+```
+
+Then import it in your project:
+
+```js
+import { getAlgoliaResults } from '@algolia/autocomplete-preset-algolia';
+```
+
+If you don't use a package manager, you can use a standalone endpoint:
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/@algolia/autocomplete-preset-algolia@alpha"></script>
+```
 
 ## Example
 
+This example uses the function along with the [`algoliasearch`](https://www.npmjs.com/package/algoliasearch) API client.
+
 ```js
 import { getAlgoliaResults } from '@algolia/autocomplete-preset-algolia';
 import algoliasearch from 'algoliasearch/lite';
 
-const searchClient = algoliasearch(APP_ID, SEARCH_API_KEY);
+const searchClient = algoliasearch(
+  'latency',
+  '6be0576ff61c053d5f9a3225e2a90f76'
+);
 
 getAlgoliaResults({
   searchClient,
@@ -28,27 +60,39 @@ getAlgoliaResults({
 });
 ```
 
-## Params
+## Parameters
 
 ### `searchClient`
 
 > `SearchClient` | required
 
+The initialized Algolia search client.
+
 ### `queries`
 
+> `MultipleQueriesQuery[]` | required
+
+The queries to perform, with the following parameters:
+
 #### `indexName`
 
 > `string` | required
 
+The index name to search into.
+
 #### `query`
 
-> `string` | required
+> `string`
+
+The query to search for.
 
 #### `params`
 
-> [`SearchParameters`](https://www.algolia.com/doc/api-reference/search-api-parameters/) | required
+> [`SearchParameters`](https://www.algolia.com/doc/api-reference/search-api-parameters/)
+
+Algolia search parameters.
 
-Default search parameters:
+These are the default search parameters. You can leave them as is and specify other parameters, or override them.
 
 ```json
 {
@@ -60,7 +104,7 @@ Default search parameters:
 
 ## Returns
 
-It returns a promise of the following schema:
+The function returns a promise that resolves to a response with the following schema:
 
 ```json
 {

packages/website/docs/partials/preset-algolia/getAlgoliaResults/intro.md

@@ -0,0 +1,3 @@
+Retrieves Algolia results from multiple indices.
+
+The `getAlgoliaResults` function lets you query several Algolia indices at once.