From 13baba4d462afc90b89d23a1e0a4f7bb2c8d3777 Mon Sep 17 00:00:00 2001 From: Karim Stekelenburg Date: Mon, 29 Jan 2024 18:17:15 +0100 Subject: [PATCH] refactor: update docs and ext links Signed-off-by: Karim Stekelenburg --- README.md | 4 ++-- guides/concepts/agents.md | 2 +- guides/concepts/platform-and-environment.md | 2 +- guides/getting-started/prerequisites.md | 2 +- guides/index.md | 2 +- guides/tutorials/agent-config/index.md | 4 ++-- guides/updating/index.md | 2 +- guides/updating/update-indy-sdk-to-askar.md | 2 +- guides/updating/versions/0.3-to-0.4.md | 4 ++-- 9 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 77d843df..9ce38c06 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ License

-Credo is an ecosystem of self-sovereign identity development tools, with [Credo](https://github.com/hyperledger/aries-framework-javascript) at the center. This documentation site serves to make it as easy as possible for developers of any level to get started with building self-sovereign identity solutions. +Credo is an ecosystem of self-sovereign identity development tools, with [Credo](https://github.com/openwallet-foundation/credo-ts) at the center. This documentation site serves to make it as easy as possible for developers of any level to get started with building self-sovereign identity solutions. # Getting Started @@ -68,7 +68,7 @@ If you are using GitHub pages for hosting, this command is a convenient way to b ## Contributing -The docs are a work in progress, contributions are incredibly appreciated! If you're looking to contribute check out the [contribution guideline](https://github.com/hyperledger/aries-javascript-docs/blob/main/CONTRIBUTING.md). +The docs are a work in progress, contributions are incredibly appreciated! If you're looking to contribute check out the [contribution guideline](https://github.com/openwallet-foundation/credo-ts-docs/blob/main/CONTRIBUTING.md). Issues are also welcomed as it gives us a good idea of the work still needing to be done. diff --git a/guides/concepts/agents.md b/guides/concepts/agents.md index 870a0dce..1f6eb98c 100644 --- a/guides/concepts/agents.md +++ b/guides/concepts/agents.md @@ -3,7 +3,7 @@ When working with any Credo implementation, you will interact with an Credo agent. This will be either directly or via a REST API, like [the Credo framework REST -API](https://github.com/hyperledger/aries-framework-javascript-ext/tree/main/packages/rest). +API](https://github.com/openwallet-foundation/credo-ts-ext/tree/main/packages/rest). ### Characteristics diff --git a/guides/concepts/platform-and-environment.md b/guides/concepts/platform-and-environment.md index cbb01179..d97d290d 100644 --- a/guides/concepts/platform-and-environment.md +++ b/guides/concepts/platform-and-environment.md @@ -1,3 +1,3 @@ # Platform and Environment -[Credo](https://github.com/hyperledger/aries-framework-javascript) is developed to support a [Node.JS](https://nodejs.org) and [React Native](https://reactnative.dev) environment. With this it is entirely possible to build an entire SSI ecosystem with Credo. This would use Node.JS as an issuer as a verifier, and uses React Native as a holder. +[Credo](https://github.com/openwallet-foundation/credo-ts) is developed to support a [Node.JS](https://nodejs.org) and [React Native](https://reactnative.dev) environment. With this it is entirely possible to build an entire SSI ecosystem with Credo. This would use Node.JS as an issuer as a verifier, and uses React Native as a holder. diff --git a/guides/getting-started/prerequisites.md b/guides/getting-started/prerequisites.md index c2c2efb9..1758afe8 100644 --- a/guides/getting-started/prerequisites.md +++ b/guides/getting-started/prerequisites.md @@ -1,6 +1,6 @@ # Prerequisites -To work with [Credo](https://github.com/hyperledger/aries-framework-javascript) we need to install some dependencies and set-up our Node.JS environment. Even when creating a mobile app in React Native, we need Node.JS installed. We will go over the specific installation process for each platform. Go ahead and pick your system of choice to get started! +To work with [Credo](https://github.com/openwallet-foundation/credo-ts) we need to install some dependencies and set-up our Node.JS environment. Even when creating a mobile app in React Native, we need Node.JS installed. We will go over the specific installation process for each platform. Go ahead and pick your system of choice to get started! The specific items that we set-up: diff --git a/guides/index.md b/guides/index.md index 4c47fc4b..941231e1 100644 --- a/guides/index.md +++ b/guides/index.md @@ -4,7 +4,7 @@ Welcome, to the Credo community! There's no way around it. Working with self-sovereign identity can be difficult. Luckily this documentation's main goal is to make it easy for you. Whether you have a lot of experience building with Aries or non-Aries SSI frameworks, or have never heard of terms like Verifiable Credential, [DID](./concepts/did-and-didcomm.md), or [Agent](./concepts/agents.md). This documentation will either help you create a JavaScript based SSI solution yourself, or help you find the right resources in the community to assist you! -So what is [Credo](https://github.com/hyperledger/aries-framework-javascript)? +So what is [Credo](https://github.com/openwallet-foundation/credo-ts)? > Hyperledger Aries provides a shared, reusable, interoperable tool kit designed for initiatives and solutions focused on creating, transmitting and storing verifiable digital credentials. > diff --git a/guides/tutorials/agent-config/index.md b/guides/tutorials/agent-config/index.md index 48249ec2..9368bd40 100644 --- a/guides/tutorials/agent-config/index.md +++ b/guides/tutorials/agent-config/index.md @@ -1,7 +1,7 @@ # Agent Config The Aries agent provided by [Aries Framework -JavaScript](https://github.com/hyperledger/aries-framework-javascript) is very +JavaScript](https://github.com/openwallet-foundation/credo-ts) is very extensible. These are all the configuration options with a short description: ## `label`\* @@ -208,7 +208,7 @@ connectionImageUrl: 'https://picsum.photos/200' Whether the storage should automatically be updated when a newer version of [Aries Framework -JavaScript](https://github.com/hyperledger/aries-framework-javascript) is used. +JavaScript](https://github.com/openwallet-foundation/credo-ts) is used. **Type**: `boolean` diff --git a/guides/updating/index.md b/guides/updating/index.md index 728d5796..92addd48 100644 --- a/guides/updating/index.md +++ b/guides/updating/index.md @@ -27,7 +27,7 @@ Breaking changes to code means changes to how you interact with Credo. This incl :::info -If you encounter any breaking changes that aren't mentioned in the migration docs, please open an issue in the [Credo Docs](https://github.com/hyperledger/aries-javascript-docs/issues) repository, or directly create a PR describing the change. +If you encounter any breaking changes that aren't mentioned in the migration docs, please open an issue in the [Credo Docs](https://github.com/openwallet-foundation/credo-ts-docs/issues) repository, or directly create a PR describing the change. ::: diff --git a/guides/updating/update-indy-sdk-to-askar.md b/guides/updating/update-indy-sdk-to-askar.md index a28fc613..1057ca7b 100644 --- a/guides/updating/update-indy-sdk-to-askar.md +++ b/guides/updating/update-indy-sdk-to-askar.md @@ -10,7 +10,7 @@ While the migration script technically works on node.js, it is strongly advised :::caution -Postgres is not supported. If you are using postgres with Indy SDK and need to update to Aries Askar, please open an issue on [GitHub](https://github.com/hyperledger/aries-framework-javascript). +Postgres is not supported. If you are using postgres with Indy SDK and need to update to Aries Askar, please open an issue on [GitHub](https://github.com/openwallet-foundation/credo-ts). ::: diff --git a/guides/updating/versions/0.3-to-0.4.md b/guides/updating/versions/0.3-to-0.4.md index e91e80c6..6f4abe0a 100644 --- a/guides/updating/versions/0.3-to-0.4.md +++ b/guides/updating/versions/0.3-to-0.4.md @@ -18,7 +18,7 @@ As noted in the [Update Indy SDK to Askar guide](../update-indy-sdk-to-askar.md) :::caution -Multi-tenancy is not covered in the 0.3.x to 0.4.x migration guide. If you're using multi-tenancy in 0.3.x and want to migrate to 0.4.x, please open an issue on [Github](https://github.com/hyperledger/aries-framework-javascript). +Multi-tenancy is not covered in the 0.3.x to 0.4.x migration guide. If you're using multi-tenancy in 0.3.x and want to migrate to 0.4.x, please open an issue on [Github](https://github.com/openwallet-foundation/credo-ts). ::: @@ -557,7 +557,7 @@ Changes to the Proofs module include: - The `config` parameter for both methods has been removed and those have been replaced by proof format specific configuration options. In this case, the `config.filterByNonRevocationRequirements` has been added as `proofFormats.indy.filterByNonRevocationRequirements` (if the `indy` format is registered as explained in the next section). The `config.filterByPresentationPreview` has been removed as the presentation preview was only present in the present proof V1 protocol, and due to it's limited applicability (the holder starts with a proposal) we've decided to remove this method for now. You can still filter the credentials yourself by using the `getCredentialsForRequest` method. - Interfaces have been renamed to be more consistent with the method names. Please refer to the [`CredentialsApiOptions`](https://github.com/openwallet-foundation/credo-ts/blob/v0.4.0/packages/core/src/modules/credentials/CredentialsApiOptions.ts) and [`ProofsApiOptions`](https://github.com/openwallet-foundation/credo-ts/blob/v0.4.0/packages/core/src/modules/proofs/ProofsApiOptions.ts) for the interface names that can be imported. -If you encounter any other breaking changes in the Proofs and Credentials modules, please open an issue in the [Credo Docs](https://github.com/hyperledger/aries-javascript-docs) repository. +If you encounter any other breaking changes in the Proofs and Credentials modules, please open an issue in the [Credo Docs](https://github.com/openwallet-foundation/credo-ts-docs) repository. ### Changes to the AnonCreds Credential and Proof Format