diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 8471bd2e..48a13080 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -26,7 +26,7 @@ All types of contributions are encouraged and valued. See the [table of contents
## Code of conduct
This project and everyone participating in it is governed by the
-[Connery code of conduct](https://github.com/connery-io/connery/blob/main/CODE_OF_CONDUCT.md).
+[Connery code of conduct](https://github.com/connery-io/connery-sdk/blob/main/CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code. Please report unacceptable behavior
to contact@connery.io.
@@ -34,11 +34,11 @@ to contact@connery.io.
> If you want to ask a question, we assume that you have read the available [Documentation](https://sdk.connery.io).
-Before you ask a question, it is best to search for existing [Discussions](https://github.com/connery-io/connery/discussions) that might help you. In case you have found a suitable discussion and still need clarification, you can write your question in this discussion. It is also advisable to search the internet for answers first.
+Before you ask a question, it is best to search for existing [Discussions](https://github.com/connery-io/connery-sdk/discussions) that might help you. In case you have found a suitable discussion and still need clarification, you can write your question in this discussion. It is also advisable to search the internet for answers first.
If you still feel the need to ask a question and need clarification, we recommend the following:
-- Open a [Discussion](https://github.com/connery-io/connery/discussions/new).
+- Open a [Discussion](https://github.com/connery-io/connery-sdk/discussions/new).
- Provide as much context as you can about what you're running into.
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
@@ -58,7 +58,7 @@ A good bug report shouldn't leave others needing to chase you up for more inform
- Make sure that you are using the latest version.
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://sdk.connery.io). If you are looking for support, you might want to check [this section](#i-have-a-question)).
-- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/connery-io/connery/issues?q=label%3Abug).
+- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/connery-io/connery-sdk/issues?q=label%3Abug).
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
- Collect information about the bug:
- Stack trace (Traceback)
@@ -73,7 +73,7 @@ A good bug report shouldn't leave others needing to chase you up for more inform
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
-- Open an [Issue](https://github.com/connery-io/connery/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
+- Open an [Issue](https://github.com/connery-io/connery-sdk/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
- Explain the behavior you would expect and the actual behavior.
- Please provide as much context as possible and describe the _reproduction steps_ that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
- Provide the information you collected in the previous section.
@@ -92,12 +92,12 @@ This section guides you through submitting an enhancement suggestion for Connery
- Make sure that you are using the latest version.
- Read the [documentation](https://sdk.connery.io) carefully and find out if the functionality is already covered, maybe by an individual configuration.
-- Perform a [search](https://github.com/connery-io/connery/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
+- Perform a [search](https://github.com/connery-io/connery-sdk/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
#### How do I submit a good enhancement suggestion?
-Enhancement suggestions are tracked as [GitHub issues](https://github.com/connery-io/connery/issues).
+Enhancement suggestions are tracked as [GitHub issues](https://github.com/connery-io/connery-sdk/issues).
- Use a **clear and descriptive title** for the issue to identify the suggestion.
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
@@ -119,11 +119,11 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/conner
### Adding plugin to the list of plugins
-If you have a plugin you would like to add to the [list of plugins](https://sdk.connery.io/docs/plugins/), please open a pull request to update the [./apps/docs/docs/plugins/index.mdx](https://github.com/connery-io/connery/blob/main/apps/docs/docs/plugins/index.mdx) file in this repository.
+If you have a plugin you would like to add to the [list of plugins](https://sdk.connery.io/docs/plugins/), please open a pull request to update the [./apps/docs/docs/plugins/index.mdx](https://github.com/connery-io/connery-sdk/blob/main/apps/docs/docs/plugins/index.mdx) file in this repository.
### Adding client to the list of clients
-If you have a client you would like to add to the [list of clients](https://sdk.connery.io/docs/clients/), please open a pull request to add a new page to the [./apps/docs/docs/clients/](https://github.com/connery-io/connery/blob/main/apps/docs/docs/clients/) folder in this repository.
+If you have a client you would like to add to the [list of clients](https://sdk.connery.io/docs/clients/), please open a pull request to add a new page to the [./apps/docs/docs/clients/](https://github.com/connery-io/connery-sdk/blob/main/apps/docs/docs/clients/) folder in this repository.
## Attribution
diff --git a/README.md b/README.md
index 878dd566..a1bc4df8 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,8 @@
# The open-source SDK for
creating AI plugins and actions
-[![Release](https://img.shields.io/github/v/release/connery-io/connery?color=74C649&label=Release)](https://github.com/connery-io/connery/releases)
-[![License](https://img.shields.io/github/license/connery-io/connery?color=74C649&label=License)](https://github.com/connery-io/connery/blob/main/LICENSE)
+[![Release](https://img.shields.io/github/v/release/connery-io/connery-sdk?color=74C649&label=Release)](https://github.com/connery-io/connery-sdk/releases)
+[![License](https://img.shields.io/github/license/connery-io/connery-sdk?color=74C649&label=License)](https://github.com/connery-io/connery-sdk/blob/main/LICENSE)
@@ -109,8 +109,8 @@ Connery is still in early beta, so not everything is perfect yet. Please let us
You can reach us via the following channels:
-- [Discussions](https://github.com/connery-io/connery/discussions) - for feedback, questions, and discussions.
-- [Issues](https://github.com/connery-io/connery/issues) - for bug reports and feature requests.
+- [Discussions](https://github.com/connery-io/connery-sdk/discussions) - for feedback, questions, and discussions.
+- [Issues](https://github.com/connery-io/connery-sdk/issues) - for bug reports and feature requests.
- [Discord](https://discord.gg/d45vsC6Z) - for community collaboration.
- [Twitter](https://twitter.com/connery_io) - for updates and announcements.
diff --git a/apps/docs/docs/clients/index.mdx b/apps/docs/docs/clients/index.mdx
index 0cef52c8..fdcad9f6 100644
--- a/apps/docs/docs/clients/index.mdx
+++ b/apps/docs/docs/clients/index.mdx
@@ -7,7 +7,7 @@ Below is a list of clients built and maintained by Connery and our community.
:::note Helpful resources
- [What is a client?](/docs/introduction/core-concepts#client)
-- To add a client to this list, please check our [contributing guide](https://github.com/connery-io/connery/blob/main/CONTRIBUTING.md).
+- To add a client to this list, please check our [contributing guide](https://github.com/connery-io/connery-sdk/blob/main/CONTRIBUTING.md).
:::
diff --git a/apps/docs/docs/clients/langchain/opengpts.mdx b/apps/docs/docs/clients/langchain/opengpts.mdx
index b3217418..dce4588c 100644
--- a/apps/docs/docs/clients/langchain/opengpts.mdx
+++ b/apps/docs/docs/clients/langchain/opengpts.mdx
@@ -6,13 +6,13 @@ Connery is integrated with OpenGPTs so you can run Connery actions from OpenGPTs
:::warning IMPORTANT
-This page is compatible with the Connery Runner ([`v0.0.8`](https://github.com/connery-io/connery/releases/tag/v0.0.8)).
-In the meantime, we released [`v0.1.0`](https://github.com/connery-io/connery/releases/tag/v0.1.0) with the breaking changes, where we pivoted the project from the Connery Runner to the Connery SDK.
+This page is compatible with the Connery Runner ([`v0.0.8`](https://github.com/connery-io/connery-sdk/releases/tag/v0.0.8)).
+In the meantime, we released [`v0.1.0`](https://github.com/connery-io/connery-sdk/releases/tag/v0.1.0) with the breaking changes, where we pivoted the project from the Connery Runner to the Connery SDK.
The Slack client does not yet support the plugins built using Connery SDK, but we are working on that.
Stay tuned for updates.
-If you have any questions or need help with the migration, please let us know in this discussion: [Connery SDK v0.1.0](https://github.com/connery-io/connery/discussions/109).
+If you have any questions or need help with the migration, please let us know in this discussion: [Connery SDK v0.1.0](https://github.com/connery-io/connery-sdk/discussions/109).
:::
diff --git a/apps/docs/docs/clients/langchain/toolkit.mdx b/apps/docs/docs/clients/langchain/toolkit.mdx
index a1288ad8..6c4aaa0d 100644
--- a/apps/docs/docs/clients/langchain/toolkit.mdx
+++ b/apps/docs/docs/clients/langchain/toolkit.mdx
@@ -5,13 +5,13 @@ Run the Connery actions from agents, chatbots, or other applications.
:::warning IMPORTANT
-This page is compatible with the Connery Runner ([`v0.0.8`](https://github.com/connery-io/connery/releases/tag/v0.0.8)).
-In the meantime, we released [`v0.1.0`](https://github.com/connery-io/connery/releases/tag/v0.1.0) with the breaking changes, where we pivoted the project from the Connery Runner to the Connery SDK.
+This page is compatible with the Connery Runner ([`v0.0.8`](https://github.com/connery-io/connery-sdk/releases/tag/v0.0.8)).
+In the meantime, we released [`v0.1.0`](https://github.com/connery-io/connery-sdk/releases/tag/v0.1.0) with the breaking changes, where we pivoted the project from the Connery Runner to the Connery SDK.
The Slack client does not yet support the plugins built using Connery SDK, but we are working on that.
Stay tuned for updates.
-If you have any questions or need help with the migration, please let us know in this discussion: [Connery SDK v0.1.0](https://github.com/connery-io/connery/discussions/109).
+If you have any questions or need help with the migration, please let us know in this discussion: [Connery SDK v0.1.0](https://github.com/connery-io/connery-sdk/discussions/109).
:::
diff --git a/apps/docs/docs/clients/make.mdx b/apps/docs/docs/clients/make.mdx
index a291e9a0..cd636ca9 100644
--- a/apps/docs/docs/clients/make.mdx
+++ b/apps/docs/docs/clients/make.mdx
@@ -4,13 +4,13 @@ Run Connery actions from the No-Code platform [Make](https://www.make.com/) usin
:::warning IMPORTANT
-This page is compatible with the Connery Runner ([`v0.0.8`](https://github.com/connery-io/connery/releases/tag/v0.0.8)).
-In the meantime, we released [`v0.1.0`](https://github.com/connery-io/connery/releases/tag/v0.1.0) with the breaking changes, where we pivoted the project from the Connery Runner to the Connery SDK.
+This page is compatible with the Connery Runner ([`v0.0.8`](https://github.com/connery-io/connery-sdk/releases/tag/v0.0.8)).
+In the meantime, we released [`v0.1.0`](https://github.com/connery-io/connery-sdk/releases/tag/v0.1.0) with the breaking changes, where we pivoted the project from the Connery Runner to the Connery SDK.
The Slack client does not yet support the plugins built using Connery SDK, but we are working on that.
Stay tuned for updates.
-If you have any questions or need help with the migration, please let us know in this discussion: [Connery SDK v0.1.0](https://github.com/connery-io/connery/discussions/109).
+If you have any questions or need help with the migration, please let us know in this discussion: [Connery SDK v0.1.0](https://github.com/connery-io/connery-sdk/discussions/109).
:::
diff --git a/apps/docs/docs/clients/openai/assistant.mdx b/apps/docs/docs/clients/openai/assistant.mdx
index 7a59b6f7..2f9540ab 100644
--- a/apps/docs/docs/clients/openai/assistant.mdx
+++ b/apps/docs/docs/clients/openai/assistant.mdx
@@ -4,13 +4,13 @@ Use Connery actions with OpenAI Assistants API.
:::warning IMPORTANT
-This page is compatible with the Connery Runner ([`v0.0.8`](https://github.com/connery-io/connery/releases/tag/v0.0.8)).
-In the meantime, we released [`v0.1.0`](https://github.com/connery-io/connery/releases/tag/v0.1.0) with the breaking changes, where we pivoted the project from the Connery Runner to the Connery SDK.
+This page is compatible with the Connery Runner ([`v0.0.8`](https://github.com/connery-io/connery-sdk/releases/tag/v0.0.8)).
+In the meantime, we released [`v0.1.0`](https://github.com/connery-io/connery-sdk/releases/tag/v0.1.0) with the breaking changes, where we pivoted the project from the Connery Runner to the Connery SDK.
The Slack client does not yet support the plugins built using Connery SDK, but we are working on that.
Stay tuned for updates.
-If you have any questions or need help with the migration, please let us know in this discussion: [Connery SDK v0.1.0](https://github.com/connery-io/connery/discussions/109).
+If you have any questions or need help with the migration, please let us know in this discussion: [Connery SDK v0.1.0](https://github.com/connery-io/connery-sdk/discussions/109).
:::
diff --git a/apps/docs/docs/clients/slack.mdx b/apps/docs/docs/clients/slack.mdx
index 51d94497..65101308 100644
--- a/apps/docs/docs/clients/slack.mdx
+++ b/apps/docs/docs/clients/slack.mdx
@@ -4,13 +4,13 @@ Use natural language to run Connery actions in your [Slack](https://slack.com/)
:::warning IMPORTANT
-This page is compatible with the Connery Runner ([`v0.0.8`](https://github.com/connery-io/connery/releases/tag/v0.0.8)).
-In the meantime, we released [`v0.1.0`](https://github.com/connery-io/connery/releases/tag/v0.1.0) with the breaking changes, where we pivoted the project from the Connery Runner to the Connery SDK.
+This page is compatible with the Connery Runner ([`v0.0.8`](https://github.com/connery-io/connery-sdk/releases/tag/v0.0.8)).
+In the meantime, we released [`v0.1.0`](https://github.com/connery-io/connery-sdk/releases/tag/v0.1.0) with the breaking changes, where we pivoted the project from the Connery Runner to the Connery SDK.
The Slack client does not yet support the plugins built using Connery SDK, but we are working on that.
Stay tuned for updates.
-If you have any questions or need help with the migration, please let us know in this discussion: [Connery SDK v0.1.0](https://github.com/connery-io/connery/discussions/109).
+If you have any questions or need help with the migration, please let us know in this discussion: [Connery SDK v0.1.0](https://github.com/connery-io/connery-sdk/discussions/109).
:::
diff --git a/apps/docs/docs/introduction/index.mdx b/apps/docs/docs/introduction/index.mdx
index e09a9be5..3512d3b4 100644
--- a/apps/docs/docs/introduction/index.mdx
+++ b/apps/docs/docs/introduction/index.mdx
@@ -1,3 +1,3 @@
# Introduction
-Check out the [README](https://github.com/connery-io/connery#readme) file of the GitHub repository for an introduction to Connery SDK.
+Check out the [README](https://github.com/connery-io/connery-sdk#readme) file of the GitHub repository for an introduction to Connery SDK.
diff --git a/apps/docs/docs/plugins/index.mdx b/apps/docs/docs/plugins/index.mdx
index 799bfe7e..e1c6ea0b 100644
--- a/apps/docs/docs/plugins/index.mdx
+++ b/apps/docs/docs/plugins/index.mdx
@@ -7,7 +7,7 @@ Below is a manually curated list of public plugins build and maintained by Conne
- [What is a plugin?](/docs/introduction/core-concepts#plugin)
- [How to create a plugin?](/docs/quickstart/create-plugin)
- [How to use a plugin?](/docs/quickstart/use-plugin)
-- To add a plugin to this list, please check our [contributing guide](https://github.com/connery-io/connery/blob/main/CONTRIBUTING.md).
+- To add a plugin to this list, please check our [contributing guide](https://github.com/connery-io/connery-sdk/blob/main/CONTRIBUTING.md).
:::
diff --git a/apps/docs/docs/sdk/api-reference.mdx b/apps/docs/docs/sdk/api-reference.mdx
index d46d5e5f..fc1fed27 100644
--- a/apps/docs/docs/sdk/api-reference.mdx
+++ b/apps/docs/docs/sdk/api-reference.mdx
@@ -4,16 +4,16 @@ Here you can find the SDK API reference for the `connery` package.
## Plugin definition types
-The [plugin definition types](https://github.com/connery-io/connery/blob/main/packages/connery/src/types/definition.ts) define the structure of a plugin and its actions.
+The [plugin definition types](https://github.com/connery-io/connery-sdk/blob/main/packages/connery/src/types/definition.ts) define the structure of a plugin and its actions.
## Plugin definition validation schema
-The [plugin definition validation schema](https://github.com/connery-io/connery/blob/main/packages/connery/src/core/utils/plugin-definition-validation-utils.ts) is used to validate a plugin definition.
+The [plugin definition validation schema](https://github.com/connery-io/connery-sdk/blob/main/packages/connery/src/core/utils/plugin-definition-validation-utils.ts) is used to validate a plugin definition.
## Action context types
-The [action context types](https://github.com/connery-io/connery/blob/main/packages/connery/src/types/context.ts) define the structure of the context object that is passed to each action.
+The [action context types](https://github.com/connery-io/connery-sdk/blob/main/packages/connery/src/types/context.ts) define the structure of the context object that is passed to each action.
## `setupPluginServer` function
-The [`setupPluginServer` function](https://github.com/connery-io/connery/blob/main/packages/connery/src/api/index.ts) is used to set up a plugin server based on a plugin definition.
+The [`setupPluginServer` function](https://github.com/connery-io/connery-sdk/blob/main/packages/connery/src/api/index.ts) is used to set up a plugin server based on a plugin definition.
diff --git a/apps/docs/docusaurus.config.js b/apps/docs/docusaurus.config.js
index dad840a2..eb99bac3 100644
--- a/apps/docs/docusaurus.config.js
+++ b/apps/docs/docusaurus.config.js
@@ -1,41 +1,42 @@
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion
-const lightCodeTheme = require('prism-react-renderer/themes/github');
-const darkCodeTheme = require('prism-react-renderer/themes/dracula');
+const lightCodeTheme = require("prism-react-renderer/themes/github");
+const darkCodeTheme = require("prism-react-renderer/themes/dracula");
/** @type {import('@docusaurus/types').Config} */
const config = {
- title: 'Connery SDK',
- url: 'https://sdk.connery.io',
- baseUrl: '/',
- onBrokenLinks: 'throw',
- onBrokenMarkdownLinks: 'warn',
+ title: "Connery SDK",
+ url: "https://sdk.connery.io",
+ baseUrl: "/",
+ onBrokenLinks: "throw",
+ onBrokenMarkdownLinks: "warn",
i18n: {
- defaultLocale: 'en',
- locales: ['en'],
+ defaultLocale: "en",
+ locales: ["en"],
},
presets: [
[
- 'classic',
+ "classic",
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
- sidebarPath: require.resolve('./sidebars.js'),
- editUrl: 'https://github.com/connery-io/connery/tree/main/apps/docs/',
+ sidebarPath: require.resolve("./sidebars.js"),
+ editUrl:
+ "https://github.com/connery-io/connery-sdk/tree/main/apps/docs/",
},
theme: {
- customCss: require.resolve('./src/css/custom.css'),
+ customCss: require.resolve("./src/css/custom.css"),
},
gtag: {
- trackingID: 'G-R8J5J4L3DQ',
+ trackingID: "G-R8J5J4L3DQ",
anonymizeIP: false,
},
sitemap: {
- changefreq: 'daily',
+ changefreq: "daily",
priority: 0.5,
- ignorePatterns: ['/tags/**'],
- filename: 'sitemap.xml',
+ ignorePatterns: ["/tags/**"],
+ filename: "sitemap.xml",
},
}),
],
@@ -43,38 +44,38 @@ const config = {
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
- image: 'img/docusaurus-social-card.jpg',
+ image: "img/docusaurus-social-card.jpg",
navbar: {
- title: 'Connery SDK',
+ title: "Connery SDK",
items: [
{
- label: 'Docs',
- docId: 'introduction/index',
- type: 'doc',
- position: 'left',
+ label: "Docs",
+ docId: "introduction/index",
+ type: "doc",
+ position: "left",
},
{
- label: 'Plugins',
- docId: 'plugins/index',
- type: 'doc',
- position: 'left',
+ label: "Plugins",
+ docId: "plugins/index",
+ type: "doc",
+ position: "left",
},
{
- label: 'Clients',
- docId: 'clients/index',
- type: 'doc',
- position: 'left',
+ label: "Clients",
+ docId: "clients/index",
+ type: "doc",
+ position: "left",
},
{
- label: 'Use cases',
- docId: 'use-cases/index',
- type: 'doc',
- position: 'left',
+ label: "Use cases",
+ docId: "use-cases/index",
+ type: "doc",
+ position: "left",
},
{
- label: '⭐ GitHub',
- href: 'https://github.com/connery-io/connery',
- position: 'right',
+ label: "⭐ GitHub",
+ href: "https://github.com/connery-io/connery-sdk",
+ position: "right",
},
],
},
@@ -83,11 +84,11 @@ const config = {
darkTheme: darkCodeTheme,
},
algolia: {
- appId: 'NM2Q08XMHT',
- apiKey: 'c1bc512e003f927e6a5bbe116e80a49c',
- indexName: 'connery',
+ appId: "NM2Q08XMHT",
+ apiKey: "c1bc512e003f927e6a5bbe116e80a49c",
+ indexName: "connery",
insights: true,
- }
+ },
}),
};
diff --git a/packages/connery/src/api/controllers/home.controller.ts b/packages/connery/src/api/controllers/home.controller.ts
index 4479f922..ebe5fe4d 100644
--- a/packages/connery/src/api/controllers/home.controller.ts
+++ b/packages/connery/src/api/controllers/home.controller.ts
@@ -54,7 +54,7 @@ export class HomeController {
- This plugin is built using Connery SDK,
the open-source SDK for AI plugins and actions development.
+ This plugin is built using Connery SDK,
the open-source SDK for AI plugins and actions development.