docs: remove clients documentation (#3526)

Author: shortcuts

CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 Welcome to the contributing guide for the api-clients-automation repository!
 
-Please read [our contributing guides](https://api-clients-automation.netlify.app/docs/contributing/introduction/) for advanced usage.
+Please read [our contributing guides](https://api-clients-automation.netlify.app/docs/introduction/) for advanced usage.
 
 If you can't find what you are looking for, please [open an issue](https://github.com/algolia/api-clients-automation/issues/new/choose).
 

README.md

@@ -17,15 +17,15 @@ The Algolia API clients are generated from [OpenAPI specs](https://swagger.io/sp
 
 **Migration note from current API clients**
 
-> In July 2022, we released an alpha version generated API clients for the JavaScript, Java and PHP languages. If you are using the latest stable of those clients and looking to upgrade, read the [migration guide](https://api-clients-automation.netlify.app/docs/clients/migration-guides/). You can still browse the documentation of the stable clients on [the Algolia documentation](https://www.algolia.com/doc/).
+> In July 2022, we released an alpha version generated API clients for the JavaScript, Java and PHP languages. If you are using the latest stable of those clients and looking to upgrade, read the [migration guide](https://www.algolia.com/doc/libraries/). You can still browse the documentation of the stable clients on [the Algolia documentation](https://www.algolia.com/doc/).
 
 ## 💡 Getting Started with the clients
 
-You can read `getting started` guides and how to use the API clients on [our documentation](https://api-clients-automation.netlify.app/docs/clients/installation).
+You can read `getting started` guides and how to use the API clients on [our documentation](https://www.algolia.com/doc/libraries/).
 
 ## ✨ Contributing
 
-> Looking to add a new client, or fix a bug? Make sure to take a look at [our contribution guides](https://api-clients-automation.netlify.app/docs/contributing/introduction).
+> Looking to add a new client, or fix a bug? Make sure to take a look at [our contribution guides](https://api-clients-automation.netlify.app/docs/introduction).
 
 ### Setup repository tooling
 
@@ -41,31 +41,31 @@ nvm use && yarn
 yarn docker:setup
 ```
 
-[Read more on our documentation](https://api-clients-automation.netlify.app/docs/contributing/setup-repository)
+[Read more on our documentation](https://api-clients-automation.netlify.app/docs/setup-repository)
 
 ### CLI
 
 The CLI allows you to make changes locally and run commands through the docker container.
 
-- [Specs CLI commands](https://api-clients-automation.netlify.app/docs/contributing/CLI/specs-commands)
-- [Clients CLI commands](https://api-clients-automation.netlify.app/docs/contributing/CLI/clients-commands)
-- [CTS CLI commands](https://api-clients-automation.netlify.app/docs/contributing/CLI/cts-commands)
+- [Specs CLI commands](https://api-clients-automation.netlify.app/docs/CLI/specs-commands)
+- [Clients CLI commands](https://api-clients-automation.netlify.app/docs/CLI/clients-commands)
+- [CTS CLI commands](https://api-clients-automation.netlify.app/docs/CLI/cts-commands)
 
 ### Guides and requirements
 
 Read the guides and requirements to:
 
-- [Add a new client](https://api-clients-automation.netlify.app/docs/contributing/add-new-api-client)
-- [Add a new language](https://api-clients-automation.netlify.app/docs/contributing/add-new-api-language)
+- [Add a new client](https://api-clients-automation.netlify.app/docs/add-new-api-client)
+- [Add a new language](https://api-clients-automation.netlify.app/docs/add-new-api-language)
 
 ### Tests
 
 Test the generated clients by running:
 
-- The [`playground`](./playground) (see [documentation](https://api-clients-automation.netlify.app/docs/contributing/testing/playground))
-- The [`Common Test Suite`](./tests/) (see [documentation](https://api-clients-automation.netlify.app/docs/contributing/testing/common-test-suite)).
+- The [`playground`](./playground) (see [documentation](https://api-clients-automation.netlify.app/docs/testing/playground))
+- The [`Common Test Suite`](./tests/) (see [documentation](https://api-clients-automation.netlify.app/docs/testing/common-test-suite)).
 
-For full documentation, visit the **[online documentation](https://api-clients-automation.netlify.app/docs/contributing/introduction)**.
+For full documentation, visit the **[online documentation](https://api-clients-automation.netlify.app/docs/introduction)**.
 
 ## ❓ Troubleshooting
 

clients/algoliasearch-client-csharp/README.md

@@ -12,7 +12,7 @@
 </p>
 
 <p align="center">
-  <a href="https://api-clients-automation.netlify.app/docs/clients/csharp/" target="_blank">Documentation</a>  •
+  <a href="https://www.algolia.com/doc/libraries/csharp/v7/" target="_blank">Documentation</a>  •
   <a href="https://discourse.algolia.com" target="_blank">Community Forum</a>  •
   <a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a>  •
   <a href="https://github.com/algolia/algoliasearch-client-csharp/issues" target="_blank">Report a bug</a>  •
@@ -98,7 +98,7 @@ Encountering an issue? Before reaching out to support, we recommend heading to o
 
 ## Contributing
 
-This repository hosts the code of the generated Algolia API client for CSharp, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/contributing/introduction).
+This repository hosts the code of the generated Algolia API client for CSharp, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/introduction).
 
 ## 📄 License
 

clients/algoliasearch-client-csharp/algoliasearch/Utils/SearchClientExtensions.cs

@@ -410,7 +410,7 @@ private static async Task<T> RetryUntil<T>(Func<Task<T>> func, Func<T, bool> val
   ///  Push a new set of objects and remove all previous ones. Settings, synonyms and query rules are untouched.
   /// Replace all objects in an index without any downtime. Internally, this method copies the existing index settings, synonyms and query rules and indexes all passed objects.
   /// Finally, the temporary one replaces the existing index. (Synchronous version)
-  /// See https://api-clients-automation.netlify.app/docs/contributing/add-new-api-client#5-helpers for implementation details.
+  /// See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
   /// </summary>
   /// <param name="indexName">The index in which to perform the request.</param>
   /// <param name="objects">The list of `objects` to store in the given Algolia `indexName`.</param>
@@ -425,7 +425,7 @@ public ReplaceAllObjectsResponse ReplaceAllObjects<T>(string indexName, IEnumera
   ///  Push a new set of objects and remove all previous ones. Settings, synonyms and query rules are untouched.
   /// Replace all objects in an index without any downtime. Internally, this method copies the existing index settings, synonyms and query rules and indexes all passed objects.
   /// Finally, the temporary one replaces the existing index.
-  /// See https://api-clients-automation.netlify.app/docs/contributing/add-new-api-client#5-helpers for implementation details.
+  /// See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
   /// </summary>
   /// <param name="indexName">The index in which to perform the request.</param>
   /// <param name="objects">The list of `objects` to store in the given Algolia `indexName`.</param>

clients/algoliasearch-client-dart/README.md

@@ -104,7 +104,7 @@ Encountering an issue? Before reaching out to support, we recommend heading to o
 
 ## Contributing
 
-This repository hosts the code of the generated Algolia API client for Dart, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/contributing/introduction).
+This repository hosts the code of the generated Algolia API client for Dart, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/introduction).
 
 ## 📄 License
 

clients/algoliasearch-client-go/README.md

@@ -88,7 +88,7 @@ Encountering an issue? Before reaching out to support, we recommend heading to o
 
 ## Contributing
 
-This repository hosts the code of the generated Algolia API client for Go, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/contributing/introduction).
+This repository hosts the code of the generated Algolia API client for Go, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/introduction).
 
 ## 📄 License
 

clients/algoliasearch-client-java/README.md

@@ -77,7 +77,7 @@ Encountering an issue? Before reaching out to support, we recommend heading to o
 
 ## Contributing
 
-This repository hosts the code of the generated Algolia API client for Java, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/contributing/introduction).
+This repository hosts the code of the generated Algolia API client for Java, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/introduction).
 
 ## 📄 License
 

clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/extensions/SearchClient.kt

@@ -397,7 +397,7 @@ public suspend fun SearchClient.partialUpdateObjects(
  * Internally, this method copies the existing index settings, synonyms and query rules and indexes all
  * passed objects. Finally, the temporary one replaces the existing index.
  *
- * See https://api-clients-automation.netlify.app/docs/contributing/add-new-api-client#5-helpers for implementation details.
+ * See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
  *
  * @param indexName The index in which to perform the request.
  * @param objects The list of objects to replace.

clients/algoliasearch-client-php/README.md

@@ -81,7 +81,7 @@ Encountering an issue? Before reaching out to support, we recommend heading to o
 
 ## Contributing
 
-This repository hosts the code of the generated Algolia API client for PHP, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/contributing/introduction).
+This repository hosts the code of the generated Algolia API client for PHP, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/introduction).
 
 ## 📄 License
 

clients/algoliasearch-client-python/README.md

@@ -88,7 +88,7 @@ Encountering an issue? Before reaching out to support, we recommend heading to o
 
 ## Contributing
 
-This repository hosts the code of the generated Algolia API client for Python, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/contributing/introduction).
+This repository hosts the code of the generated Algolia API client for Python, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/introduction).
 
 ## 📄 License
 

clients/algoliasearch-client-ruby/README.md

@@ -55,7 +55,7 @@ Encountering an issue? Before reaching out to support, we recommend heading to o
 
 ## Contributing
 
-This repository hosts the code of the generated Algolia API client for Ruby, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/contributing/introduction).
+This repository hosts the code of the generated Algolia API client for Ruby, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/introduction).
 
 ## 📄 License
 

clients/algoliasearch-client-scala/README.md

@@ -124,7 +124,7 @@ Encountering an issue? Before reaching out to support, we recommend heading to o
 
 ## Contributing
 
-This repository hosts the code of the generated Algolia API client for Scala, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/contributing/introduction).
+This repository hosts the code of the generated Algolia API client for Scala, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/introduction).
 
 ## 📄 License
 

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/extension/package.scala

@@ -326,7 +326,7 @@ package object extension {
       * settings, synonyms and query rules and indexes all passed objects. Finally, the temporary one replaces the
       * existing index.
       *
-      * See https://api-clients-automation.netlify.app/docs/contributing/add-new-api-client#5-helpers for implementation
+      * See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation
       * details.
       *
       * @param indexName

clients/algoliasearch-client-swift/README.md

@@ -161,7 +161,7 @@ Encountering an issue? Before reaching out to support, we recommend heading to o
 
 ## Contributing
 
-This repository hosts the code of the generated Algolia API client for Swift, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/contributing/introduction).
+This repository hosts the code of the generated Algolia API client for Swift, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/introduction).
 
 ## 📄 License
 

clients/algoliasearch-client-swift/Sources/Search/Extra/SearchClientExtension.swift

@@ -527,7 +527,7 @@ public extension SearchClient {
 
     /// Replace all objects in an index
     ///
-    /// See https://api-clients-automation.netlify.app/docs/contributing/add-new-api-client#5-helpers for implementation
+    /// See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation
     /// details.
     /// - parameter indexName: The name of the index where to replace the objects
     /// - parameter objects: The new objects

generators/src/main/java/com/algolia/codegen/cts/tests/TestsRequest.java

@@ -136,7 +136,7 @@ public void run(Map<String, CodegenModel> models, Map<String, CodegenOperation>
           operationId +
           ".json'.\n" +
           "You can read more on the documentation:" +
-          " https://api-clients-automation.netlify.app/docs/contributing/testing/common-test-suite"
+          " https://api-clients-automation.netlify.app/docs/testing/common-test-suite"
         );
       }
       Request[] op = cts.get(operationId);

scripts/specs/format.ts

@@ -70,11 +70,6 @@ export async function transformBundle({
 
   if (docs) {
     const snippets = transformCodeSamplesToGuideMethods(JSON.parse(JSON.stringify(snippetSamples)));
-    // the JS file will be removed once algolia/doc leverages the JSON one
-    await fsp.writeFile(
-      toAbsolutePath(`website/src/generated/${clientName}-snippets.js`),
-      `export const snippets = ${snippets}`,
-    );
     await fsp.writeFile(toAbsolutePath(`snippets/guides/${clientName}-snippets.json`), snippets);
   }
 

specs/bundled/README.md

@@ -2,4 +2,4 @@
 
 **Please do not edit the files in this folder, they are generated and changes will be overwritten by our scripts**
 
-[Read more on our documentation](https://api-clients-automation.netlify.app/docs/contributing/introduction)
+[Read more on our documentation](https://api-clients-automation.netlify.app/docs/introduction)

templates/go/search_helpers.mustache

@@ -637,7 +637,7 @@ func (c *APIClient) ChunkedBatch(indexName string, objects []map[string]any, act
 
 /*
 ReplaceAllObjects replaces all objects (records) in the given `indexName` with the given `objects`. A temporary index is created during this process in order to backup your data.
-See https://api-clients-automation.netlify.app/docs/contributing/add-new-api-client#5-helpers for implementation details.
+See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
 
   @param indexName string - the index name to replace objects into.
   @param objects []map[string]any - List of objects to replace.
@@ -690,4 +690,4 @@ func (c *APIClient) ReplaceAllObjects(indexName string, objects []map[string]any
 		BatchResponses:        batchResp,
 		MoveOperationResponse: *moveResp,
 	}, nil
-}
+}

templates/java/api_helpers.mustache

@@ -597,7 +597,7 @@ public <T> List<BatchResponse> chunkedBatch(String indexName, Iterable<T> object
 /**
 * Push a new set of objects and remove all previous ones. Settings, synonyms and query rules are
 * untouched. Replace all records in an index without any downtime. See
-* https://api-clients-automation.netlify.app/docs/contributing/add-new-api-client#5-helpers for
+* https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for
 * implementation details.
 *
 * @param indexName The `indexName` to replace `objects` in.
@@ -715,7 +715,7 @@ return chunkedBatch(indexName, objects, createIfNotExists ? Action.PARTIAL_UPDAT
 /**
 * Push a new set of objects and remove all previous ones. Settings, synonyms and query rules are
 * untouched. Replace all records in an index without any downtime.
-* See https://api-clients-automation.netlify.app/docs/contributing/add-new-api-client#5-helpers for implementation details.
+* See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
 *
 * @param indexName The `indexName` to replace `objects` in.
 * @param objects The array of `objects` to store in the given Algolia `indexName`.

templates/javascript/clients/client/api/helpers.mustache

@@ -409,7 +409,7 @@ async partialUpdateObjects(
 
 /**
  * Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
- * See https://api-clients-automation.netlify.app/docs/contributing/add-new-api-client#5-helpers for implementation details.
+ * See https://api-clients-automation.netlify.app/docs/add-new-api-client#5-helpers for implementation details.
  *
  * @summary Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
  * @param replaceAllObjects - The `replaceAllObjects` object.