Skip to content

Commit

Permalink
Merge pull request #136 from connery-io:change-docs-urls
Browse files Browse the repository at this point in the history
Update docs URLs
  • Loading branch information
machulav authored Nov 17, 2024
2 parents c2bad7a + 2484bbc commit 3f6a08e
Show file tree
Hide file tree
Showing 8 changed files with 19 additions and 59 deletions.
14 changes: 3 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ to [email protected].

## I have a question

> If you want to ask a question, we assume that you have read the available [Documentation](https://sdk.connery.io).
> If you want to ask a question, we assume that you have read the available [Documentation](https://docs.connery.io/sdk).
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.

Expand All @@ -57,7 +57,7 @@ We will then take care of the discussion as soon as possible.
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

- 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)).
- 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://docs.connery.io/sdk). 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-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:
Expand Down Expand Up @@ -91,7 +91,7 @@ This section guides you through submitting an enhancement suggestion for Connery
#### Before submitting an enhancement

- 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.
- Read the [documentation](https://docs.connery.io/sdk) carefully and find out if the functionality is already covered, maybe by an individual configuration.
- 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.

Expand All @@ -117,14 +117,6 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/conner

<!-- TODO: Updating, improving and correcting the documentation. -->

### 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-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-sdk/blob/main/apps/docs/docs/clients/) folder in this repository.

## Attribution

This guide is based on the [Contributing-Gen](https://github.com/bttger/contributing-gen).
52 changes: 10 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@
## 🤔 What is Connery SDK?

Connery SDK is an NPM package that includes both an SDK and a CLI, designed for the development
of [plugins](https://sdk.connery.io/docs/introduction/core-concepts#plugin)
and [actions](https://sdk.connery.io/docs/introduction/core-concepts#action).
of [plugins](https://docs.connery.io/sdk/get-started/core-concepts#plugin)
and [actions](https://docs.connery.io/sdk/get-started/core-concepts#action).

The CLI automates many things in the development process.
Meanwhile, the SDK offers a JavaScript API for defining plugins and actions and packaging them
into a [plugin server](https://sdk.connery.io/docs/introduction/core-concepts#plugin-server) with a standardized REST API generated from the metadata.
into a [plugin server](https://docs.connery.io/sdk/get-started/core-concepts#plugin-server) with a standardized REST API generated from the metadata.
The plugin server handles authorization, input validation, and logging.
So you can focus on the logic of your actions.

The standardized API enables various [clients](https://sdk.connery.io/docs/introduction/core-concepts#client) to interact
with actions in a unified way, regardless of the underlying implementation.
~~The standardized API enables various clients to interact
with actions in a unified way, regardless of the underlying implementation.~~

An action consists of JavaSctipt code that defines its logic and metadata that describes its input and output.
The action can communicate with external APIs, databases, or other services.
Expand Down Expand Up @@ -54,54 +54,23 @@ npm start

Open the plugin in the browser: [localhost:4201](http://localhost:4201).

👉 _Check out the [full quickstart guide](https://sdk.connery.io/docs/quickstart/) to learn more._
👉 _Check out the [full quickstart guide](https://docs.connery.io/sdk/guides/create-a-plugin) to learn more._

## ✅ Example 1: Send email from an OpenAI GPT

<img alt="Send email from an OpenAI GPT" src="./img/send-email-from-a-custom-gpt-using-connery-actions.gif">

👉 _Learn more: [OpenAI GPT client](https://sdk.connery.io/docs/clients/openai/gpt)._

## ✅ Example 2: Summarize a webpage and send it by email from OpenGPTs

<img alt="Summarize a webpage and send it by email from OpenGPTs" src="./img/summarize-a-webpage-and-send-it-by-email-from-opengpts.gif">

👉 _Learn more: [LangChain OpenGPTs client](https://sdk.connery.io/docs/clients/langchain/opengpts)._

## ✅ Example 3: Scale back-end service on AWS from Slack
## ✅ Example: Scale back-end service on AWS from Slack

<img alt="Scheduled scaling of Back End service on AWS Fargate from Slack using Connery" src="./img/scheduled-scaling-of-back-end-service-on-aws-fargate-from-slack-using-connery.gif">

👉 _Learn more: [Slack client](https://sdk.connery.io/docs/clients/slack)._
👉 _Learn more: Slack client._

## 🌟 Support us and stay up-to-date

Please **give the repository a star** to support the project and stay up-to-date with the latest news.

<img src="./img/give-us-a-star.png" alt="Give the repository a star" width="300">

## 💡 Use cases

- [Actions in GPTs](https://sdk.connery.io/docs/use-cases/actions-in-gpts/)
- [Actions in AI agents and apps](https://sdk.connery.io/docs/use-cases/actions-in-ai-agents-and-apps/)
- [Actions in AI wearables](https://sdk.connery.io/docs/use-cases/actions-in-ai-wearables/)
- [Actions in team collaboration tools](https://sdk.connery.io/docs/use-cases/actions-in-team-collaboration-tools/)
- [Custom actions in No-Code tools](https://sdk.connery.io/docs/use-cases/custom-actions-in-no-code-tools/)
- [Actions in CI/CD pipelines](https://sdk.connery.io/docs/use-cases/actions-in-ci-cd-pipelines)

## 🌳 Ecosystem

We aim to build a community-driven ecosystem of open-source plugins and clients.
So, anyone can benefit from the shared knowledge and resources to accelerate innovation.

Below are manually curated lists of open-source plugins built with Connery SDK and clients for interacting with them:

- [Plugins](https://sdk.connery.io/docs/plugins/)
- [Clients](https://sdk.connery.io/docs/clients/)

## 📖 Documentation

Check out the [documentation](https://sdk.connery.io) to learn more.
Check out the [documentation](https://docs.connery.io/sdk) to learn more.

## 💬 Feedback & Support

Expand All @@ -111,7 +80,6 @@ You can reach us via the following channels:

- [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.

## 🗄️ Repository structure
Expand All @@ -121,7 +89,7 @@ This is a monorepo that contains the following components:
| Name | Path | Description |
| ------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| SDK&nbsp;&&nbsp;CLI | `./packages/connery` | The [`connery`](https://www.npmjs.com/package/connery) package that contains both the SDK and CLI for plugins and actions development. |
| Docs | `./apps/docs` | The [documentation](https://sdk.connery.io/) website. |
| Docs | `./docs` | The [documentation](https://docs.connery.io/sdk) website. |

## 👨‍💻 Contributing

Expand Down
Binary file not shown.
Binary file not shown.
2 changes: 1 addition & 1 deletion packages/connery/src/api/controllers/home.controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ export class HomeController {
</p>
<a
class="inline-flex items-center justify-center h-10 px-4 text-sm font-medium rounded-md border border-gray-200 bg-white text-gray-900 shadow-sm transition-colors hover:bg-gray-100 hover:text-gray-900 focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-gray-950"
href="https://sdk.connery.io/docs/quickstart/use-plugin"
href="https://docs.connery.io/sdk/guides/use-a-plugin"
target="_blank"
>
Learn how to use the plugin and its actions
Expand Down
4 changes: 2 additions & 2 deletions packages/connery/src/cli/init/templates/.env.example.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
export default `# Learn more about the configuration at
# https://sdk.connery.io/docs/sdk/plugin-server/configuration
export default `# Learn more about the plugin server configuration at
# https://docs.connery.io/sdk/advanced/plugin-server#configuration
API_KEY=123456
`;
4 changes: 2 additions & 2 deletions packages/connery/src/cli/init/templates/.env.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
export default `# Learn more about the configuration at
# https://sdk.connery.io/docs/sdk/plugin-server/configuration
export default `# Learn more about the plugin server configuration at
# https://docs.connery.io/sdk/advanced/plugin-server#configuration
API_KEY=123456
`;
2 changes: 1 addition & 1 deletion packages/connery/src/cli/init/templates/README.md.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This repository contains the plugin's source code.
This plugin is built using [Connery SDK](https://github.com/connery-io/connery-sdk), the open-source SDK for creating AI plugins and actions.
[Learn how to use the plugin and its actions.](https://sdk.connery.io/docs/quickstart/use-plugin)
[Learn how to use the plugin and its actions.](https://docs.connery.io/sdk/guides/use-a-plugin)
## Support
Expand Down

0 comments on commit 3f6a08e

Please sign in to comment.