Skip to content

Commit e6f485a

Browse files
authored
docs: update README and docs website (#104)
2 parents 0db5548 + 22822a2 commit e6f485a

File tree

74 files changed

+6891
-4897
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+6891
-4897
lines changed

.devcontainer/devcontainer.json

-33
This file was deleted.

.devcontainer/post-start-commands.sh

-7
This file was deleted.

.github/workflows/release.yml renamed to .github/workflows/release-sdk.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Release
1+
name: Release SDK
22

33
on:
44
push:

.gitignore

-10
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,5 @@ out
88
# local env files
99
.env
1010

11-
# turbo
12-
.turbo
13-
14-
# vscode
15-
.vscode/*
16-
!.vscode/settings.json
17-
!.vscode/tasks.json
18-
!.vscode/launch.json
19-
!.vscode/extensions.json
20-
2111
# misc
2212
.DS_Store

.npmrc

-1
This file was deleted.

CONTRIBUTING.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ to [email protected].
3232

3333
## I have a question
3434

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

@@ -57,7 +57,7 @@ We will then take care of the discussion as soon as possible.
5757
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.
5858

5959
- Make sure that you are using the latest version.
60-
- 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). If you are looking for support, you might want to check [this section](#i-have-a-question)).
60+
- 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)).
6161
- 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).
6262
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
6363
- Collect information about the bug:
@@ -91,7 +91,7 @@ This section guides you through submitting an enhancement suggestion for Connery
9191
#### Before submitting an enhancement
9292

9393
- Make sure that you are using the latest version.
94-
- Read the [documentation](https://docs.connery.io) carefully and find out if the functionality is already covered, maybe by an individual configuration.
94+
- Read the [documentation](https://sdk.connery.io) carefully and find out if the functionality is already covered, maybe by an individual configuration.
9595
- 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.
9696
- 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.
9797

@@ -119,11 +119,11 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/conner
119119

120120
### Adding plugin to the list of plugins
121121

122-
If you have a plugin you would like to add to the [list of plugins](https://docs.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.
122+
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.
123123

124124
### Adding client to the list of clients
125125

126-
If you have a client you would like to add to the [list of clients](https://docs.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.
126+
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.
127127

128128
## Attribution
129129

0 commit comments

Comments
 (0)