Skip to content

[Improvement] Remove Python v3 and TS v2 docs #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
g-despot merged 14 commits into from
Sep 25, 2025
Merged

[Improvement] Remove Python v3 and TS v2 docs #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
371850f
Remove Py V3 docs
g-despot Mar 23, 2025
c43a05c
Rename explicit v4 mentions
g-despot Mar 23, 2025
1681b57
Merge branch 'main' into remove-python-client-v3
g-despot Sep 10, 2025
a82734d
Update docs
g-despot Sep 10, 2025
f99eb43
Rename Python client
g-despot Sep 10, 2025
6d40e02
Update docs
g-despot Sep 10, 2025
22079db
Merge pull request #166 from weaviate/remove-ts-client-v2
g-despot Sep 17, 2025
578afc3
Update docs
g-despot Sep 17, 2025
c71838f
Update deprecation messages
g-despot Sep 17, 2025
54a35b4
Merge branch 'main' into remove-python-client-v3
g-despot Sep 25, 2025
0759638
Update docs
g-despot Sep 25, 2025
f3ebfd4
Add docs archive links
g-despot Sep 25, 2025
2b33b0c
Fix links
g-despot Sep 25, 2025
cd36fd7
Update docs
g-despot Sep 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 2 additions & 9 deletions .vscode/markdown.code-snippets
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@
"```",
"",
"</TabItem>",
"<TabItem value=\"js\" label=\"JavaScript\">",
"<TabItem value=\"js\" label=\"JS/TS\">",
"",
"```js",
"<!-- JavaScript code goes here -->",
Expand Down Expand Up @@ -261,21 +261,14 @@
"import TabItem from '@theme/TabItem';",
"",
"<Tabs groupId=\"languages\">",
"<TabItem value=\"py\" label=\"Python Client v4\">",
"<TabItem value=\"py\" label=\"Python\">",
"",
"```python",
"# Python v4 example goes here",
"# note there is an empty line before this code snippet,",
"# without the empty line the code won't render",
"```",
"</TabItem>",
"<TabItem value=\"py3\" label=\"Python Client v3\">",
"",
"```python",
"# Python v3 example goes here",
"```",
"",
"</TabItem>",
"</Tabs>",
],
"description": "Adds the tabs section for code examples"
Expand Down
4 changes: 2 additions & 2 deletions _includes/clients/ts-client-intro.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
The TypeScript client supports code that is written in TypeScript or JavaScript.

The **v3 client** is the current TypeScript client. If you have code written for the v2 client, you should [migrate it to v3](/weaviate/client-libraries/typescript/v2_v3_migration) as the v2 client is no longer maintained.
The **v3 client** is the current TypeScript client. If you have code written for the [v2 client](/weaviate/client-libraries/typescript#javascripttypescript-client-v2-deprecation), you should migrate it to v3 as the v2 client is no longer maintained.

:::note

The v3 client supports server side development (Node.js hosted). If your application is browser based, you might consider using the [TypeScript client v2](/weaviate/client-libraries/typescript/typescript-v2). Keep in mind that the v2 client is outdated and no longer officially maintained.
The v3 client supports server side development (Node.js hosted). If your application is browser based, you might consider using the [TypeScript client v2](/weaviate/client-libraries/typescript#javascripttypescript-client-v2-deprecation). Keep in mind that the v2 client is outdated and no longer officially maintained.

:::
7 changes: 0 additions & 7 deletions _includes/code/EMPTY.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,6 @@ import TabItem from '@theme/TabItem';

```

</TabItem>
<TabItem value="js" label="JS/TS Client v2">

```js

```

</TabItem>
<TabItem value="go" label="Go">

Expand Down
22 changes: 2 additions & 20 deletions _includes/code/configuration/replication-consistency.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import PyCode from '!!raw-loader!/_includes/code/howto/manage-data.collections.py';
import PyCodeV3 from '!!raw-loader!/_includes/code/howto/manage-data.collections-v3.py';
import TSCode from '!!raw-loader!/_includes/code/howto/manage-data.collections.ts';
import TSCodeLegacy from '!!raw-loader!/_includes/code/howto/manage-data.collections-v2.ts';
import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBlock';


<Tabs groupId="languages">
<TabItem value="py" label="Python Client v4">
<TabItem value="py" label="Python">
<FilteredTextBlock
text={PyCode}
startMarker="# START AsyncRepair"
Expand All @@ -17,16 +15,8 @@ import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBl
/>
</TabItem>

<TabItem value="py3" label="Python Client v3">
<FilteredTextBlock
text={PyCodeV3}
startMarker="# START AsyncRepair"
endMarker="# END AsyncRepair"
language="pyv3"
/>
</TabItem>

<TabItem value="js" label="JS/TS Client v3">
<TabItem value="js" label="JS/TS">
<FilteredTextBlock
text={TSCode}
startMarker="// START AsyncRepair"
Expand All @@ -35,14 +25,6 @@ import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBl
/>
</TabItem>

<TabItem value="js2" label="JS/TS Client v2">
<FilteredTextBlock
text={TSCodeLegacy}
startMarker="// START AsyncRepair"
endMarker="// END AsyncRepair"
language="tsv2"
/>
</TabItem>
<TabItem value="curl" label="cURL">

```bash
Expand Down
22 changes: 2 additions & 20 deletions _includes/code/connections/oidc-connect.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,45 +3,27 @@ import TabItem from '@theme/TabItem';
import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBlock';

import PyV4Code from '!!raw-loader!/_includes/code/connections/connect-python-v4.py';
import PyV3Code from '!!raw-loader!/_includes/code/connections/connect-python-v3.py';
import TsV3Code from '!!raw-loader!/_includes/code/connections/connect-ts-v3.ts';
import TsV2Code from '!!raw-loader!/_includes/code/connections/connect-ts-v2.ts';
import JavaCode from '!!raw-loader!/_includes/code/connections/connect.java';
import GoCode from '!!raw-loader!/_includes/code/connections/connect.go';

<Tabs groupId="languages">
<TabItem value="py4" label="Python Client v4">
<TabItem value="py4" label="Python">
<FilteredTextBlock
text={PyV4Code}
startMarker="# START OIDCConnect"
endMarker="# END OIDCConnect"
language="py"
/>
</TabItem>
<TabItem value="py3" label="Python Client v3">
<FilteredTextBlock
text={PyV3Code}
startMarker="# START OIDCConnect"
endMarker="# END OIDCConnect"
language="pyv3"
/>
</TabItem>
<TabItem value="ts3" label="JS/TS Client v3">
<TabItem value="ts3" label="JS/TS">
<FilteredTextBlock
text={TsV3Code}
startMarker="// START OIDCConnect"
endMarker="// END OIDCConnect"
language="js"
/>
</TabItem>
<TabItem value="ts2" label="JS/TS Client v2">
<FilteredTextBlock
text={TsV2Code}
startMarker="// START OIDCConnect"
endMarker="// END OIDCConnect"
language="tsv2"
/>
</TabItem>
<TabItem value="go" label="Go">
<FilteredTextBlock
text={GoCode}
Expand Down
4 changes: 2 additions & 2 deletions _includes/code/connections/timeouts-cloud.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ import PyV4Code from '!!raw-loader!/_includes/code/connections/connect-python-v4
import TsV3Code from '!!raw-loader!/_includes/code/connections/connect-ts-v3.ts';

<Tabs groupId="languages">
<TabItem value="py4" label="Python Client v4">
<TabItem value="py4" label="Python">
<FilteredTextBlock
text={PyV4Code}
startMarker="# START TimeoutWCD"
endMarker="# END TimeoutWCD"
language="py"
/>
</TabItem>
<TabItem value="ts3" label="JS/TS Client v3">
<TabItem value="ts3" label="JS/TS">
<FilteredTextBlock
text={TsV3Code}
startMarker="// START TimeoutWCD"
Expand Down
4 changes: 2 additions & 2 deletions _includes/code/connections/timeouts-custom.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ import PyV4Code from '!!raw-loader!/_includes/code/connections/connect-python-v4
import TsV3Code from '!!raw-loader!/_includes/code/connections/connect-ts-v3.ts';

<Tabs groupId="languages">
<TabItem value="py4" label="Python Client v4">
<TabItem value="py4" label="Python">
<FilteredTextBlock
text={PyV4Code}
startMarker="# START TimeoutCustom"
endMarker="# END TimeoutCustom"
language="py"
/>
</TabItem>
<TabItem value="ts3" label="JS/TS Client v3">
<TabItem value="ts3" label="JS/TS">
<FilteredTextBlock
text={TsV3Code}
startMarker="// START TimeoutCustom"
Expand Down
4 changes: 2 additions & 2 deletions _includes/code/connections/timeouts-local.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ import TsV3Code from '!!raw-loader!/_includes/code/connections/connect-ts-v3.ts'


<Tabs groupId="languages">
<TabItem value="py4" label="Python Client v4">
<TabItem value="py4" label="Python">
<FilteredTextBlock
text={PyV4Code}
startMarker="# START TimeoutLocal"
endMarker="# END TimeoutLocal"
language="py"
/>
</TabItem>
<TabItem value="ts3" label="JS/TS Client v3">
<TabItem value="ts3" label="JS/TS">
<FilteredTextBlock
text={TsV3Code}
startMarker="// START TimeoutLocal"
Expand Down
20 changes: 0 additions & 20 deletions _includes/code/contextionary.extensions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,26 +12,6 @@ client = weaviate.Client("http://localhost:8080")
client.contextionary.extend("weaviate", "Open source cloud native real time vector database", 1.0)
```

</TabItem>
<TabItem value="js" label="JS/TS Client v2">

```js
import weaviate from 'weaviate-ts-client';

const client = weaviate.client({
scheme: 'http',
host: 'localhost:8080',
});

const response = await client.c11y
.extensionCreator()
.withConcept('weaviate')
.withDefinition('Open source cloud native real time vector database')
.withWeight(1)
.do();
console.log(JSON.stringify(response, null, 2));
```

</TabItem>
<TabItem value="go" label="Go">

Expand Down
18 changes: 0 additions & 18 deletions _includes/code/contextionary.get.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,24 +13,6 @@ concept_info = client.contextionary.get_concept_vector("fashionMagazine")
print(concept_info)
```

</TabItem>
<TabItem value="js" label="JS/TS Client v2">

```js
import weaviate from 'weaviate-ts-client';

const client = weaviate.client({
scheme: 'http',
host: 'localhost:8080',
});

const response = await client.c11y
.conceptsGetter()
.withConcept('fashionMagazine')
.do();
console.log(JSON.stringify(response, null, 2));
```

</TabItem>
<TabItem value="go" label="Go">

Expand Down
19 changes: 0 additions & 19 deletions _includes/code/core.client.openai.apikey.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,25 +18,6 @@ client = weaviate.Client(
)
```

</TabItem>
<TabItem value="js" label="JS/TS Client v2">

```js
import weaviate from 'weaviate-ts-client';

const client = weaviate.client({
scheme: 'https',
host: 'WEAVIATE_INSTANCE_URL',
// highlight-start
// Replace with your API key
headers: {
'X-OpenAI-Api-Key': 'YOUR-OPENAI-API-KEY',
'X-Azure-Api-Key': 'YOUR-AZURE-API-KEY',
},
// highlight-end
});
```

</TabItem>
<TabItem value="go" label="Go">

Expand Down
21 changes: 1 addition & 20 deletions _includes/code/embedded.instantiate.custom.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,14 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBlock';
import PyCode from '!!raw-loader!/_includes/code/install/embedded.py';
import PyCodeV3 from '!!raw-loader!/_includes/code/install/embedded-v3.py';
import TsCodeV2 from '!!raw-loader!/_includes/code/install/embedded-v2.ts';
import TsCodeV2CustomModules from '!!raw-loader!/_includes/code/install/embedded-v2-custommodules.ts';

<Tabs groupId="languages">
<TabItem value="py" label="Python Client v4">
<TabItem value="py" label="Python">
<FilteredTextBlock
text={PyCode}
startMarker="# START FullInstantiationEmbedded"
endMarker="# END FullInstantiationEmbedded"
language="py"
/>
</TabItem>
<TabItem value="py3" label="Python Client v3">
<FilteredTextBlock
text={PyCodeV3}
startMarker="# START CustomModules"
endMarker="# END CustomModules"
language="pyv3"
/>
</TabItem>
<TabItem value="js" label="JS/TS Client v2">
<FilteredTextBlock
text={TsCodeV2CustomModules}
startMarker="// START CustomModules"
endMarker="// END CustomModules"
language="tsv2"
/>
</TabItem>
</Tabs>
20 changes: 1 addition & 19 deletions _includes/code/embedded.instantiate.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,14 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBlock';
import PyCode from '!!raw-loader!/_includes/code/install/embedded.py';
import PyCodeV3 from '!!raw-loader!/_includes/code/install/embedded-v3.py';
import TsCodeV2 from '!!raw-loader!/_includes/code/install/embedded-v2.ts';

<Tabs groupId="languages">
<TabItem value="py" label="Python Client v4">
<TabItem value="py" label="Python">
<FilteredTextBlock
text={PyCode}
startMarker="# START SimpleInstantiationEmbedded"
endMarker="# END SimpleInstantiationEmbedded"
language="py"
/>
</TabItem>
<TabItem value="py3" label="Python Client v3">
<FilteredTextBlock
text={PyCodeV3}
startMarker="# START SimpleInstance"
endMarker="# END SimpleInstance"
language="pyv3"
/>
</TabItem>
<TabItem value="js" label="JS/TS Client v2">
<FilteredTextBlock
text={TsCodeV2}
startMarker="// START SimpleInstance"
endMarker="// END SimpleInstance"
language="tsv2"
/>
</TabItem>
</Tabs>
21 changes: 1 addition & 20 deletions _includes/code/embedded.instantiate.module.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,14 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBlock';
import PyCode from '!!raw-loader!/_includes/code/install/embedded.py';
import PyCodeV3 from '!!raw-loader!/_includes/code/install/embedded-v3.py';
import TsCodeV2 from '!!raw-loader!/_includes/code/install/embedded-v2.ts';
import TsCodeV2CustomModules from '!!raw-loader!/_includes/code/install/embedded-v2-custommodules.ts';

<Tabs groupId="languages">
<TabItem value="py" label="Python Client v4">
<TabItem value="py" label="Python">
<FilteredTextBlock
text={PyCode}
startMarker="# START ModuleInstantiationEmbedded"
endMarker="# END ModuleInstantiationEmbedded"
language="py"
/>
</TabItem>
<TabItem value="py3" label="Python Client v3">
<FilteredTextBlock
text={PyCodeV3}
startMarker="# START CustomModules"
endMarker="# END CustomModules"
language="pyv3"
/>
</TabItem>
<TabItem value="js" label="JS/TS Client v2">
<FilteredTextBlock
text={TsCodeV2CustomModules}
startMarker="// START CustomModules"
endMarker="// END CustomModules"
language="tsv2"
/>
</TabItem>
</Tabs>
Loading
Loading