fix: widget name in documentation link for index (#4172)

For technical reason we were not able to use `index` as widget name in
the docs, so we picked instead `index-widget`.

When you misuse a widget, we output an error message with a link to the
documentation generated from the name of the widget.

This commit handle the special case of the index widget.

src/widgets/index/__tests__/index-test.ts

@@ -97,7 +97,7 @@ describe('index', () => {
     }).toThrowErrorMatchingInlineSnapshot(`
 "The \`indexName\` option is required.
 
-See documentation: https://www.algolia.com/doc/api-reference/widgets/index/js/"
+See documentation: https://www.algolia.com/doc/api-reference/widgets/index-widget/js/"
 `);
   });
 
@@ -107,7 +107,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/index/js/"
     }).toThrowErrorMatchingInlineSnapshot(`
 "The \`indexName\` option is required.
 
-See documentation: https://www.algolia.com/doc/api-reference/widgets/index/js/"
+See documentation: https://www.algolia.com/doc/api-reference/widgets/index-widget/js/"
 `);
   });
 
@@ -169,7 +169,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/index/js/"
       }).toThrowErrorMatchingInlineSnapshot(`
 "The \`addWidgets\` method expects an array of widgets.
 
-See documentation: https://www.algolia.com/doc/api-reference/widgets/index/js/"
+See documentation: https://www.algolia.com/doc/api-reference/widgets/index-widget/js/"
 `);
     });
 
@@ -181,7 +181,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/index/js/"
       }).toThrowErrorMatchingInlineSnapshot(`
 "The widget definition expects a \`render\` and/or an \`init\` method.
 
-See documentation: https://www.algolia.com/doc/api-reference/widgets/index/js/"
+See documentation: https://www.algolia.com/doc/api-reference/widgets/index-widget/js/"
 `);
     });
 
@@ -366,7 +366,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/index/js/"
       }).toThrowErrorMatchingInlineSnapshot(`
 "The \`removeWidgets\` method expects an array of widgets.
 
-See documentation: https://www.algolia.com/doc/api-reference/widgets/index/js/"
+See documentation: https://www.algolia.com/doc/api-reference/widgets/index-widget/js/"
 `);
     });
 
@@ -378,7 +378,7 @@ See documentation: https://www.algolia.com/doc/api-reference/widgets/index/js/"
       }).toThrowErrorMatchingInlineSnapshot(`
 "The widget definition expects a \`dispose\` method.
 
-See documentation: https://www.algolia.com/doc/api-reference/widgets/index/js/"
+See documentation: https://www.algolia.com/doc/api-reference/widgets/index-widget/js/"
 `);
     });
 

src/widgets/index/index.ts

@@ -26,7 +26,7 @@ import {
 } from '../../lib/utils';
 
 const withUsage = createDocumentationMessageGenerator({
-  name: 'index',
+  name: 'index-widget',
 });
 
 type IndexProps = {