diff --git a/README.md b/README.md index c9009d5f421..1c1f37e6b69 100644 --- a/README.md +++ b/README.md @@ -17,11 +17,11 @@ 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://www.algolia.com/doc/libraries/). 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/sdk/upgrade). 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://www.algolia.com/doc/libraries/). +You can read `getting started` guides and how to use the API clients on [our documentation](https://www.algolia.com/doc/libraries/sdk/install). ## ✨ Contributing diff --git a/clients/algoliasearch-client-csharp/README.md b/clients/algoliasearch-client-csharp/README.md index 33460b0605c..ea64294129b 100644 --- a/clients/algoliasearch-client-csharp/README.md +++ b/clients/algoliasearch-client-csharp/README.md @@ -12,7 +12,7 @@

- Documentation • + Documentation • Community Forum • Stack Overflow • Report a bug • @@ -32,7 +32,7 @@ **Migration note from v5.x to v6.x** -> In January 2019, we released v6 of our .NET client. If you are using version 5.x of the client, read the [migration guide to version 6.x](https://www.algolia.com/doc/api-client/getting-started/upgrade-guides/csharp/). +> In January 2019, we released v6 of our .NET client. If you are using version 5.x of the client, read the [migration guide to version 6.x](https://www.algolia.com/doc/libraries/sdk/v1/upgrade/csharp). Version 5.x will **no longer** be under active development. ## 💡 Getting Started @@ -89,7 +89,7 @@ var response = await client.SearchAsync( ); ``` -For full documentation, visit the **[Algolia CSharp API Client](https://www.algolia.com/doc/libraries/csharp/)**. +For full documentation, visit the **[Algolia CSharp API Client](https://www.algolia.com/doc/libraries/sdk/install#c%23)**. ## ❓ Troubleshooting diff --git a/clients/algoliasearch-client-go/README.md b/clients/algoliasearch-client-go/README.md index 89cb9f895cd..275404ce820 100644 --- a/clients/algoliasearch-client-go/README.md +++ b/clients/algoliasearch-client-go/README.md @@ -15,7 +15,7 @@

- Documentation • + Documentation • Community Forum • Stack Overflow • Report a bug • @@ -79,7 +79,7 @@ if err != nil { print(response) ``` -For full documentation, visit the **[Algolia Go API Client](https://www.algolia.com/doc/libraries/go/)**. +For full documentation, visit the **[Algolia Go API Client](https://www.algolia.com/doc/libraries/sdk/install#go)**. ## ❓ Troubleshooting diff --git a/clients/algoliasearch-client-java/README.md b/clients/algoliasearch-client-java/README.md index 8b60a2e1ab6..2b58b3b4d31 100644 --- a/clients/algoliasearch-client-java/README.md +++ b/clients/algoliasearch-client-java/README.md @@ -12,7 +12,7 @@

- Documentation • + Documentation • Community Forum • Stack Overflow • Report a bug • @@ -68,7 +68,7 @@ client.search( ); ``` -For full documentation, visit the **[Algolia Java API Client](https://www.algolia.com/doc/libraries/java/)**. +For full documentation, visit the **[Algolia Java API Client](https://www.algolia.com/doc/libraries/sdk/install#java)**. ## ❓ Troubleshooting diff --git a/clients/algoliasearch-client-javascript/README.md b/clients/algoliasearch-client-javascript/README.md index 0ef1d640b06..bee174e2ebf 100644 --- a/clients/algoliasearch-client-javascript/README.md +++ b/clients/algoliasearch-client-javascript/README.md @@ -14,12 +14,11 @@

- Documentation • + Documentation • InstantSearch • Community Forum • Stack Overflow • Report a bug • - FAQ • Support

@@ -72,11 +71,11 @@ 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/libraries/javascript/v5/methods/search/)**. +For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/sdk/methods/search/)**. ## ❓ Troubleshooting -Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/libraries/javascript/v5/) 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://support.algolia.com/hc/en-us/sections/15061037630609-API-Client-FAQs) 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 diff --git a/clients/algoliasearch-client-kotlin/README.md b/clients/algoliasearch-client-kotlin/README.md index e9e583caaeb..641c45acfbc 100644 --- a/clients/algoliasearch-client-kotlin/README.md +++ b/clients/algoliasearch-client-kotlin/README.md @@ -12,7 +12,7 @@

- Documentation • + Documentation • Community Forum • Stack Overflow • Report a bug • @@ -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/libraries/kotlin/)**. +For full documentation, visit the **[Algolia Kotlin API Client](https://www.algolia.com/doc/libraries/sdk/install#kotlin)**. ## ❓ Troubleshooting diff --git a/clients/algoliasearch-client-php/README.md b/clients/algoliasearch-client-php/README.md index a15f9b1478c..f77374d8d03 100644 --- a/clients/algoliasearch-client-php/README.md +++ b/clients/algoliasearch-client-php/README.md @@ -14,7 +14,7 @@

- Documentation • + Documentation • Laravel • Symfony • Community Forum • @@ -72,7 +72,7 @@ $response = $client->search( var_dump($response); ``` -For full documentation, visit the **[Algolia PHP API Client](https://www.algolia.com/doc/libraries/php/)**. +For full documentation, visit the **[Algolia PHP API Client](https://www.algolia.com/doc/libraries/sdk/install#php)**. ## ❓ Troubleshooting diff --git a/clients/algoliasearch-client-python/README.md b/clients/algoliasearch-client-python/README.md index 44464a3d4bf..ebfbc9ff77e 100644 --- a/clients/algoliasearch-client-python/README.md +++ b/clients/algoliasearch-client-python/README.md @@ -13,7 +13,7 @@

- Documentation • + Documentation • Django • Community Forum • Stack Overflow • @@ -79,7 +79,7 @@ print(response) print(response.to_json()) ``` -For full documentation, visit the **[Algolia Python API Client](https://www.algolia.com/doc/libraries/python/)**. +For full documentation, visit the **[Algolia Python API Client](https://www.algolia.com/doc/libraries/sdk/install#python)**. ## ❓ Troubleshooting diff --git a/clients/algoliasearch-client-ruby/README.md b/clients/algoliasearch-client-ruby/README.md index 02adfbe9b72..77c2b93d34b 100644 --- a/clients/algoliasearch-client-ruby/README.md +++ b/clients/algoliasearch-client-ruby/README.md @@ -13,7 +13,7 @@

- Documentation • + Documentation • Rails • Community Forum • Stack Overflow • @@ -46,7 +46,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/libraries/ruby/)**. +For full documentation, visit the **[Algolia Ruby API Client](https://www.algolia.com/doc/libraries/sdk/install#ruby)**. ## ❓ Troubleshooting diff --git a/clients/algoliasearch-client-scala/README.md b/clients/algoliasearch-client-scala/README.md index 82eeb5e2798..bdc012bf929 100644 --- a/clients/algoliasearch-client-scala/README.md +++ b/clients/algoliasearch-client-scala/README.md @@ -12,7 +12,7 @@

- Documentation • + Documentation • Community Forum • Stack Overflow • Report a bug • @@ -115,7 +115,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/libraries/scala/)**. +For full documentation, visit the **[Algolia Scala API Client](https://www.algolia.com/doc/libraries/sdk/install#scala)**. ## ❓ Troubleshooting diff --git a/clients/algoliasearch-client-swift/README.md b/clients/algoliasearch-client-swift/README.md index 25a01e99858..76481061f54 100644 --- a/clients/algoliasearch-client-swift/README.md +++ b/clients/algoliasearch-client-swift/README.md @@ -29,7 +29,7 @@

- Documentation • + Documentation • Community Forum • Stack Overflow • Report a bug • @@ -132,7 +132,7 @@ let response: SearchResponses = try await client ))])) ``` -For full documentation, visit the **[Algolia Swift API Client](https://www.algolia.com/doc/libraries/swift/)**. +For full documentation, visit the **[Algolia Swift API Client](https://www.algolia.com/doc/libraries/sdk/install#swift)**. ## Notes diff --git a/scripts/ci/codegen/__tests__/__snapshots__/createGithubReleases.test.ts.snap b/scripts/ci/codegen/__tests__/__snapshots__/createGithubReleases.test.ts.snap index 61a34a9d57a..cc60652a294 100644 --- a/scripts/ci/codegen/__tests__/__snapshots__/createGithubReleases.test.ts.snap +++ b/scripts/ci/codegen/__tests__/__snapshots__/createGithubReleases.test.ts.snap @@ -17,7 +17,7 @@ exports[`createGithubRelease > generates a release 1`] = ` **Full Changelog**: https://github.com/algolia/algoliasearch-client-dart/compare/5.19.0...5.20.0 -→ [Browse the Algolia documentation](https://www.algolia.com/doc/libraries/dart) +→ [Browse the Algolia documentation](https://www.algolia.com/doc/libraries/sdk/install#dart) ", "name": "5.20.0", "owner": "algolia", diff --git a/scripts/ci/codegen/createGitHubReleases.ts b/scripts/ci/codegen/createGitHubReleases.ts index 9f163637e2a..8400b0baea2 100644 --- a/scripts/ci/codegen/createGitHubReleases.ts +++ b/scripts/ci/codegen/createGitHubReleases.ts @@ -65,7 +65,7 @@ ${stripCommitMessage(changelog)} **Full Changelog**: ${repositoryLink}/compare/${previousVersion}...${newVersion} -→ [Browse the Algolia documentation](https://www.algolia.com/doc/libraries/${lang}) +→ [Browse the Algolia documentation](https://www.algolia.com/doc/libraries/sdk/install#${lang === 'csharp' ? 'c%23' : lang}) `; try { diff --git a/templates/csharp/netcore_project.mustache b/templates/csharp/netcore_project.mustache index 6d23d586c86..9bf544a0d7c 100644 --- 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. icon.png - https://www.algolia.com/doc/libraries/csharp/ + https://www.algolia.com/doc/libraries/sdk/install#c%23 MIT https://github.com/algolia/algoliasearch-client-csharp git diff --git a/templates/javascript/clients/README.mustache b/templates/javascript/clients/README.mustache index 2838fd78682..3afa4c2e134 100644 --- a/templates/javascript/clients/README.mustache +++ b/templates/javascript/clients/README.mustache @@ -14,12 +14,11 @@

- Documentation • + Documentation • InstantSearch • Community Forum • Stack Overflow • Report a bug • - FAQ • Support

@@ -90,11 +89,11 @@ const client = {{clientName}}('YOUR_APP_ID', 'YOUR_API_KEY'); {{/isAlgoliasearchClient}} ``` -For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/{{#lambda.kebabcase}}{{apiName}}{{/lambda.kebabcase}}/)**. +For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/sdk/methods/{{#lambda.kebabcase}}{{apiName}}{{/lambda.kebabcase}}/)**. ## ❓ Troubleshooting -Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/libraries/javascript/v5/) 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://support.algolia.com/hc/en-us/sections/15061037630609-API-Client-FAQs) 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 diff --git a/templates/kotlin/README.mustache b/templates/kotlin/README.mustache index 8a3d11a1d4d..9d41278531a 100644 --- a/templates/kotlin/README.mustache +++ b/templates/kotlin/README.mustache @@ -12,7 +12,7 @@

- Documentation • + Documentation • Community Forum • Stack Overflow • Report a bug • @@ -113,7 +113,7 @@ var response = client.search( println(response) ``` -For full documentation, visit the **[Algolia Kotlin API Client](https://www.algolia.com/doc/libraries/kotlin/v3/)**. +For full documentation, visit the **[Algolia Kotlin API Client](https://www.algolia.com/doc/libraries/sdk/install#kotlin)**. ## ❓ Troubleshooting diff --git a/templates/swift/podspec.mustache b/templates/swift/podspec.mustache index 36828276b24..328d5e517ba 100644 --- a/templates/swift/podspec.mustache +++ b/templates/swift/podspec.mustache @@ -7,7 +7,7 @@ Pod::Spec.new do |s| s.license = { :type => 'MIT', :file => 'LICENSE' } s.homepage = 'https://github.com/algolia/algoliasearch-client-swift/tree/main' s.summary = 'Algolia Search API Client written in Swift.' - s.documentation_url = 'https://www.algolia.com/doc/api-client/getting-started/what-is-the-api-client/swift/' + s.documentation_url = 'https://www.algolia.com/doc/libraries/sdk/install#swift' s.ios.deployment_target = '14.0' s.osx.deployment_target = '11.0' s.watchos.deployment_target = '7.0' @@ -24,4 +24,4 @@ Pod::Spec.new do |s| subs.dependency '{{projectName}}/Core' end {{/packageList}} -end \ No newline at end of file +end diff --git a/website/docs/CLI/build-commands.md b/website/docs/CLI/build-commands.md index cff68373b18..e40f69e1442 100644 --- a/website/docs/CLI/build-commands.md +++ b/website/docs/CLI/build-commands.md @@ -24,11 +24,11 @@ apic build specs ### Available options -| Option | Command | Description | -| ---------- | :--------------- | :------------------------------------------------------------- | -| verbose | -v, --verbose | Make the process verbose, display logs from third party tools | -| skip cache | -s, --skip-cache | Skip cache checking to force building specs | -| docs | -d, --docs | Builds the specs for the Algolia doc, which embeds the snippets| +| Option | Command | Description | +| ---------- | :--------------- | :-------------------------------------------------------------- | +| verbose | -v, --verbose | Make the process verbose, display logs from third party tools | +| skip cache | -s, --skip-cache | Skip cache checking to force building specs | +| docs | -d, --docs | Builds the specs for the Algolia doc, which embeds the snippets | ## Build specs diff --git a/website/docs/CLI/cts-commands.md b/website/docs/CLI/cts-commands.md index 748b23063da..0b2712b2991 100644 --- a/website/docs/CLI/cts-commands.md +++ b/website/docs/CLI/cts-commands.md @@ -27,7 +27,7 @@ apic cts generate ### Available options | Option | Command | Description | -|----------|:---------------|:----------------------------------------------------------------------------------| +| -------- | :------------- | :-------------------------------------------------------------------------------- | | verbose | -v, --verbose | Make the process verbose, display logs from third party tools | | debugger | -d, --debugger | runs the generator in debug mode, it will wait for a Java debugger to be attached | diff --git a/website/docs/CLI/generate-commands.md b/website/docs/CLI/generate-commands.md index e7608e53867..b7600e44ad0 100644 --- a/website/docs/CLI/generate-commands.md +++ b/website/docs/CLI/generate-commands.md @@ -25,7 +25,7 @@ apic generate ### Available options | Option | Command | Description | -|----------|:---------------|:----------------------------------------------------------------------------------| +| -------- | :------------- | :-------------------------------------------------------------------------------- | | verbose | -v, --verbose | Make the process verbose, display logs from third party tools | | debugger | -d, --debugger | runs the generator in debug mode, it will wait for a Java debugger to be attached | diff --git a/website/docs/add-a-new-api/api-documentation-guidelines.md b/website/docs/add-a-new-api/api-documentation-guidelines.md index 7c4900bd9d0..7064be19e54 100644 --- a/website/docs/add-a-new-api/api-documentation-guidelines.md +++ b/website/docs/add-a-new-api/api-documentation-guidelines.md @@ -29,7 +29,6 @@ To make using the specs in these contexts easier, follow these guidelines: - Prefer using `externalDocs` objects over inline Markdown links. - Use inline Markdown links judiciously. They don't render in CLI/code environments. - - Don't link to readily searchable information, such as internet RFCs or Wikipedia. - Don't link to endpoints of other Algolia APIs. These links won't be portable. diff --git a/website/docs/custom-helpers.md b/website/docs/custom-helpers.md index a0e0608a0e5..35ec3be987b 100644 --- a/website/docs/custom-helpers.md +++ b/website/docs/custom-helpers.md @@ -33,7 +33,6 @@ This section explains the decision over the implementation of complicated helper ::: - ### `replaceAllObjects` :::caution diff --git a/website/docs/introduction.md b/website/docs/introduction.md index 8568915338c..b00b263a2c4 100644 --- a/website/docs/introduction.md +++ b/website/docs/introduction.md @@ -4,7 +4,7 @@ title: Introduction # Introduction -This section hosts informations about the [API clients automation](https://github.com/algolia/api-clients-automation) repository. For informations regarding the clients usage, see [the Algolia documentation](https://www.algolia.com/doc/libraries/). +This section hosts informations about the [API clients automation](https://github.com/algolia/api-clients-automation) repository. For informations regarding the clients usage, see [the Algolia documentation](https://www.algolia.com/doc/libraries/sdk/install). ## Contributing diff --git a/website/docs/setup-repository.md b/website/docs/setup-repository.md index ee65e30b2e2..1999436ff1f 100644 --- a/website/docs/setup-repository.md +++ b/website/docs/setup-repository.md @@ -7,6 +7,7 @@ title: Setup repository :::info Make sure to have: + - [Docker installed so you don't have to install the tooling for every API clients](https://docs.docker.com/desktop/mac/install/) - [jq because it's nice](https://jqlang.github.io/jq/download/) @@ -26,7 +27,7 @@ We use multiple docker images to simplify the build. There is [one base image](h yarn docker:setup ``` -## Tooling +## Tooling :::info diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 961340ff92a..ca7e4737613 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -9,7 +9,6 @@ organizationName: 'Algolia', projectName: 'Algolia API clients automation', onBrokenLinks: 'throw', - onBrokenMarkdownLinks: 'throw', presets: [ [ @@ -96,5 +95,11 @@ copyright: `Copyright © ${new Date().getFullYear()} Algolia | Built with Docusaurus.`, }, }), + markdown: { + hooks: { + onBrokenMarkdownLinks: 'throw', + onBrokenMarkdownImages: 'throw', + }, + }, } ); diff --git a/website/sidebars.js b/website/sidebars.js index 0f6c7e327ac..695820d4632 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -28,7 +28,11 @@ const sidebars = { type: 'category', label: 'Add a new API', collapsed: false, - items: ['add-a-new-api/write-a-specification', 'add-a-new-api/generate-your-client', 'add-a-new-api/api-documentation-guidelines'], + items: [ + 'add-a-new-api/write-a-specification', + 'add-a-new-api/generate-your-client', + 'add-a-new-api/api-documentation-guidelines', + ], }, 'add-a-new-language', { diff --git a/website/src/css/custom.css b/website/src/css/custom.css index 0cc0b29dc7e..7e4d11a7338 100644 --- a/website/src/css/custom.css +++ b/website/src/css/custom.css @@ -10,9 +10,9 @@ --ifm-color-primary: #5468ff; --ifm-footer-background-color: #f5f5fa; --ifm-menu-color-background-active: var(--ifm-color-emphasis-200); - --ifm-font-family-base: Open Sans, system-ui, BlinkMacSystemFont, - -apple-system, Segoe UI, Roboto, Oxygen, Ubuntu, Cantarell, Fira Sans, - Droid Sans, Helvetica Neue, sans-serif; + --ifm-font-family-base: + Open Sans, system-ui, BlinkMacSystemFont, -apple-system, Segoe UI, Roboto, + Oxygen, Ubuntu, Cantarell, Fira Sans, Droid Sans, Helvetica Neue, sans-serif; } html[data-theme='dark'] { diff --git a/website/src/pages/index.js b/website/src/pages/index.js index c1bb7a21bd7..539edb39fd2 100644 --- a/website/src/pages/index.js +++ b/website/src/pages/index.js @@ -22,7 +22,7 @@ function Hero() { width={160} height={30} title="GitHub Stars" - /> + />, ]} >