chore: doc links and other readmes

algolia · Aug 20, 2024 · e67cd65 · e67cd65
1 parent 638a8bb
commit e67cd65
Show file tree

Hide file tree

Showing 13 changed files with 29 additions and 37 deletions.
diff --git a/clients/algoliasearch-client-csharp/README.md b/clients/algoliasearch-client-csharp/README.md
@@ -90,7 +90,7 @@ var response = await client.SearchAsync<Object>(
 );
 ```
 
-For full documentation, visit the **[Algolia CSharp API Client](https://www.algolia.com/doc/api-client/getting-started/install/csharp/)**.
+For full documentation, visit the **[Algolia CSharp API Client](https://www.algolia.com/doc/libraries/csharp/)**.
 
 ## ❓ Troubleshooting
 

diff --git a/clients/algoliasearch-client-go/README.md b/clients/algoliasearch-client-go/README.md
@@ -15,7 +15,7 @@
 </p>
 
 <p align="center">
-  <a href="https://www.algolia.com/doc/api-client/getting-started/install/go/" target="_blank">Documentation</a>  •
+  <a href="https://www.algolia.com/doc/libraries/go/" 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-go/issues" target="_blank">Report a bug</a>  •
@@ -80,7 +80,7 @@ if err != nil {
 print(response)
 ```
 
-For full documentation, visit the **[Algolia Go API Client](https://www.algolia.com/doc/api-client/getting-started/install/go/)**.
+For full documentation, visit the **[Algolia Go API Client](https://www.algolia.com/doc/libraries/go/)**.
 
 ## ❓ Troubleshooting
 

diff --git a/clients/algoliasearch-client-java/README.md b/clients/algoliasearch-client-java/README.md
@@ -12,7 +12,7 @@
 </p>
 
 <p align="center">
-  <a href="https://www.algolia.com/doc/api-client/getting-started/install/java/" target="_blank">Documentation</a>  •
+  <a href="https://www.algolia.com/doc/libraries/java/" 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-java/issues" target="_blank">Report a bug</a>  •
@@ -69,7 +69,7 @@ client.search(
 );
 ```
 
-For full documentation, visit the **[Algolia Java API Client](https://www.algolia.com/doc/api-client/getting-started/install/java/)**.
+For full documentation, visit the **[Algolia Java API Client](https://www.algolia.com/doc/libraries/java/)**.
 
 ## ❓ Troubleshooting
 

diff --git a/clients/algoliasearch-client-javascript/README.md b/clients/algoliasearch-client-javascript/README.md
@@ -14,7 +14,7 @@
 </p>
 
 <p align="center">
-  <a href="https://www.algolia.com/doc/api-client/getting-started/install/javascript/" target="_blank">Documentation</a>  •
+  <a href="https://www.algolia.com/doc/libraries/javascript/" target="_blank">Documentation</a>  •
   <a href="https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/" target="_blank">InstantSearch</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>  •
@@ -63,12 +63,12 @@ import { liteClient } from 'algoliasearch/lite';
 const client = liteClient('YOUR_APP_ID', 'YOUR_API_KEY');
 ```
 
-For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/api-client/getting-started/install/javascript/)**.
+For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.
 
 ## ❓ Troubleshooting
 
 Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/javascript/) where you will find answers for the most common issues and gotchas with the client. You can also open [a GitHub issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&projects=&template=Bug_report.md)
 
 ## 📄 License
 
-The Algolia JavaScript API Client is an open-sourced software licensed under the [MIT license](LICENSE).
+The Algolia JavaScript API Client is an open-sourced software licensed under the [MIT license](LICENSE).
diff --git a/clients/algoliasearch-client-kotlin/README.md b/clients/algoliasearch-client-kotlin/README.md
@@ -12,7 +12,7 @@
 </p>
 
 <p align="center">
-  <a href="https://www.algolia.com/doc/api-client/getting-started/install/kotlin/" target="_blank">Documentation</a>  •
+  <a href="https://www.algolia.com/doc/libraries/kotlin/" 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-kotlin/issues" target="_blank">Report a bug</a>  •
@@ -47,7 +47,7 @@ Install the Kotlin client by adding the following dependency to your `gradle.bui
   ```
 Also, choose and add to your dependencies one of [Ktor http client engines](https://ktor.io/docs/http-client-engines.html).
 Alternatively, you can use [algoliasearch-client-kotlin-bom](/client-bom).  
-For full documentation, visit the **[Algolia Kotlin API Client](https://www.algolia.com/doc/api-client/getting-started/install/kotlin/)**.
+For full documentation, visit the **[Algolia Kotlin API Client](https://www.algolia.com/doc/libraries/kotlin/)**.
 
 ### Guides
 

diff --git a/clients/algoliasearch-client-php/README.md b/clients/algoliasearch-client-php/README.md
@@ -14,7 +14,7 @@
 </p>
 
 <p align="center">
-  <a href="https://www.algolia.com/doc/api-client/getting-started/install/php/" target="_blank">Documentation</a>  •
+  <a href="https://www.algolia.com/doc/libraries/php/" target="_blank">Documentation</a>  •
   <a href="https://github.com/algolia/scout-extended" target="_blank">Laravel</a>  •
   <a href="https://github.com/algolia/search-bundle" target="_blank">Symfony</a>  •
   <a href="https://discourse.algolia.com" target="_blank">Community Forum</a>  •
@@ -73,7 +73,7 @@ $response = $client->search(
 var_dump($response);
 ```
 
-For full documentation, visit the **[Algolia PHP API Client](https://www.algolia.com/doc/api-client/getting-started/install/php/)**.
+For full documentation, visit the **[Algolia PHP API Client](https://www.algolia.com/doc/libraries/php/)**.
 
 ## ❓ Troubleshooting
 

diff --git a/clients/algoliasearch-client-python/README.md b/clients/algoliasearch-client-python/README.md
@@ -13,7 +13,7 @@
 </p>
 
 <p align="center">
-  <a href="https://www.algolia.com/doc/api-client/getting-started/install/python/" target="_blank">Documentation</a>  •
+  <a href="https://www.algolia.com/doc/libraries/python/" target="_blank">Documentation</a>  •
   <a href="https://github.com/algolia/algoliasearch-django" target="_blank">Django</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>  •
@@ -80,7 +80,7 @@ print(response)
 print(response.to_json())
 ```
 
-For full documentation, visit the **[Algolia Python API Client](https://www.algolia.com/doc/api-client/getting-started/install/python/)**.
+For full documentation, visit the **[Algolia Python API Client](https://www.algolia.com/doc/libraries/python/)**.
 
 ## ❓ Troubleshooting
 

diff --git a/clients/algoliasearch-client-ruby/README.md b/clients/algoliasearch-client-ruby/README.md
@@ -13,7 +13,7 @@
 </p>
 
 <p align="center">
-  <a href="https://www.algolia.com/doc/api-client/getting-started/install/ruby/" target="_blank">Documentation</a>  •
+  <a href="https://www.algolia.com/doc/libraries/ruby/" target="_blank">Documentation</a>  •
   <a href="https://github.com/algolia/algoliasearch-rails" target="_blank">Rails</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>  •
@@ -47,7 +47,7 @@ Finally, you may begin searching a object using the `search` method:
 objects = client.search_single_index('your_index_name', 'Foo')
 ```
 
-For full documentation, visit the **[Algolia Ruby API Client](https://www.algolia.com/doc/api-client/getting-started/install/ruby/)**.
+For full documentation, visit the **[Algolia Ruby API Client](https://www.algolia.com/doc/libraries/ruby/)**.
 
 ## ❓ Troubleshooting
 

diff --git a/clients/algoliasearch-client-scala/README.md b/clients/algoliasearch-client-scala/README.md
@@ -12,7 +12,7 @@
 </p>
 
 <p align="center">
-  <a href="https://www.algolia.com/doc/api-client/getting-started/install/scala/" target="_blank">Documentation</a>  •
+  <a href="https://www.algolia.com/doc/libraries/scala/" target="_blank">Documentation</a>  •
   <a href="https://discourse.algolia.com" target="_blank">Community Forum</a>  •
   <a href="https://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a>  •
   <a href="https://github.com/algolia/algoliasearch-client-scala/issues" target="_blank">Report a bug</a>  •
@@ -116,7 +116,7 @@ val response = client.search(
 val value = Await.result(response, Duration(100, "sec"))
 ```
 
-For full documentation, visit the **[Algolia Scala API Client](https://www.algolia.com/doc/api-client/getting-started/install/scala/)**.
+For full documentation, visit the **[Algolia Scala API Client](https://www.algolia.com/doc/libraries/scala/)**.
 
 ## ❓ Troubleshooting
 

diff --git a/clients/algoliasearch-client-swift/README.md b/clients/algoliasearch-client-swift/README.md
@@ -29,7 +29,7 @@
 
 
 <p align="center">
-  <a href="https://www.algolia.com/doc/api-client/getting-started/install/swift/" target="_blank">Documentation</a>  •
+  <a href="https://www.algolia.com/doc/libraries/swift/" 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-swift/issues" target="_blank">Report a bug</a>  •
@@ -133,7 +133,7 @@ let response: SearchResponses<Hit> = try await client
     ))]))
 ```
 
-For full documentation, visit the **[Algolia Swift API Client](https://www.algolia.com/doc/api-client/getting-started/install/swift/)**.
+For full documentation, visit the **[Algolia Swift API Client](https://www.algolia.com/doc/libraries/swift/)**.
 
 ## Notes
 

diff --git a/templates/csharp/netcore_project.mustache b/templates/csharp/netcore_project.mustache
@@ -15,7 +15,7 @@
       Algolia is a powerful search-as-a-service solution, made easy to use with API clients, UI libraries, and pre-built integrations. Algolia API Client for the .NET framework lets you easily use the Algolia Search REST API from your .NET code.
     </PackageDescription>
     <PackageIcon>icon.png</PackageIcon>
-    <PackageProjectUrl>https://www.algolia.com/doc/api-client/getting-started/install/csharp/</PackageProjectUrl>
+    <PackageProjectUrl>https://www.algolia.com/doc/libraries/csharp/</PackageProjectUrl>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <RepositoryUrl>https://github.com/algolia/algoliasearch-client-csharp</RepositoryUrl>
     <RepositoryType>git</RepositoryType>

diff --git a/templates/javascript/clients/README.mustache b/templates/javascript/clients/README.mustache
@@ -14,7 +14,7 @@
 </p>
 
 <p align="center">
-  <a href="https://www.algolia.com/doc/api-client/getting-started/install/javascript/" target="_blank">Documentation</a>  •
+  <a href="https://www.algolia.com/doc/libraries/javascript/" target="_blank">Documentation</a>  •
   <a href="https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/" target="_blank">InstantSearch</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>  •
@@ -70,7 +70,7 @@ const client = {{apiName}}('YOUR_APP_ID', 'YOUR_API_KEY');
 {{/isAlgoliasearchClient}}
 ```
 
-For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/api-client/getting-started/install/javascript/)**.
+For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.
 
 ## ❓ Troubleshooting
 

diff --git a/templates/kotlin/README.mustache b/templates/kotlin/README.mustache
@@ -3,7 +3,7 @@
     <img alt="Algolia for Kotlin" src="https://raw.githubusercontent.com/algolia/algoliasearch-client-common/master/banners/kotlin.png" >
   </a>
 
-<h4 align="center">The perfect starting point to integrate <a href="https://algolia.com" target="_blank">Algolia</a> within your Kotlin project</h4>
+  <h4 align="center">The perfect starting point to integrate <a href="https://algolia.com" target="_blank">Algolia</a> within your Kotlin project</h4>
 
   <p align="center">
     <a href="https://search.maven.org/search?q=a:algoliasearch-client-kotlin"><img src="https://img.shields.io/maven-central/v/com.algolia/algoliasearch-client-kotlin?label=Download" alt="Latest version"></img></a>
@@ -12,7 +12,7 @@
 </p>
 
 <p align="center">
-  <a href="https://www.algolia.com/doc/api-client/getting-started/install/kotlin/" target="_blank">Documentation</a>  •
+  <a href="https://www.algolia.com/doc/libraries/kotlin/" 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-kotlin/issues" target="_blank">Report a bug</a>  •
@@ -114,24 +114,16 @@ var response = client.search(
 println(response)
 ```
 
-For full documentation, visit the **[Algolia Kotlin API Client](https://www.algolia.com/doc/api-client/getting-started/install/kotlin/)**.
-
-### Guides
-
-- [Getting started](https://github.com/algolia/algoliasearch-client-kotlin/tree/master/docs/GettingStarted.md)
-- [DSL](https://github.com/algolia/algoliasearch-client-kotlin/tree/master/docs/DSL.md)
-- [Serialization](https://github.com/algolia/algoliasearch-client-kotlin/tree/master/docs/Serialization.md)
-- [ExceptionHandling](https://github.com/algolia/algoliasearch-client-kotlin/tree/master/docs/ExceptionHandling.md)
-- [Configure the HTTP client](https://github.com/algolia/algoliasearch-client-kotlin/tree/master/docs/HTTPClient.md)
+For full documentation, visit the **[Algolia Kotlin API Client](https://www.algolia.com/doc/libraries/kotlin/)**.
 
 ## ❓ Troubleshooting
 
-Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/kotlin/) where you will find answers for the most common issues and gotchas with the client. You can also open [a GitHub issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&projects=&template=Bug_report.md)
+Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/go/) where you will find answers for the most common issues and gotchas with the client. You can also open [a GitHub issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&projects=&template=Bug_report.md)
 
 ## Contributing
 
-This repository hosts the code of the generated Algolia API client for Kotlin, 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).
+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
 
-The Algolia Kotlin API Client is an open-sourced software licensed under the [MIT license](LICENSE).
+The Algolia Go API Client is an open-sourced software licensed under the [MIT license](LICENSE).
-Original file line number
+Diff line change
@@ Expand Up / @@ -90,7 +90,7 @@ var response = await client.SearchAsync<Object>( @@
     );
     ```
-    For full documentation, visit the **[Algolia CSharp API Client](https://www.algolia.com/doc/api-client/getting-started/install/csharp/)**.
+    For full documentation, visit the **[Algolia CSharp API Client](https://www.algolia.com/doc/libraries/csharp/)**.
     ## ❓ Troubleshooting
@@ Expand Down @@