refactor: rename to Credo (#143)

Signed-off-by: Karim Stekelenburg <karim@animo.id>
openwallet-foundation · Jan 29, 2024 · 013aaf0 · 013aaf0
1 parent 8ec85e6
commit 013aaf0
Show file tree

Hide file tree

Showing 103 changed files with 6,642 additions and 170 deletions.
diff --git a/.github/ISSUE_TEMPLATE/documentation-request.yml b/.github/ISSUE_TEMPLATE/documentation-request.yml
@@ -1,5 +1,5 @@
 name: Documentation Request
-description: File a request to document a specific functionality in the Aries JavaScript ecosystem.
+description: File a request to document a specific functionality in the Credo ecosystem.
 title: '[Request]: '
 labels: ['request']
 body:
@@ -19,7 +19,7 @@ body:
     id: platform
     attributes:
       label: Version
-      description: Which version of Aries Framework JavaScript are you using?
+      description: Which version of Credo are you using?
       placeholder: 0.x.x
     validations:
       required: true

diff --git a/.github/settings.yml b/.github/settings.yml
@@ -4,7 +4,7 @@
 
 repository:
   name: credo-ts-docs
-  description: Extension libraries for Aries Framework JavaScript
+  description: Extension libraries for Credo
   homepage: https://github.com/openwallet-foundation/credo-ts-docs
   default_branch: main
   has_downloads: false

diff --git a/MAINTAINERS.md b/MAINTAINERS.md
@@ -1,3 +1,3 @@
 ## Maintainers
 
-See [MAINTAINERS.md](https://github.com/hyperledger/aries-framework-javascript/blob/main/MAINTAINERS.md) in the Aries Framework JavaScript repository.
+See [MAINTAINERS.md](https://github.com/openwallet-foundation/credo-ts/blob/main/MAINTAINERS.md) in the Credo repository.
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
     height="250px"
   />
 </p>
-<h1 align="center"><b>Aries JavaScript Documentation</b></h1>
+<h1 align="center"><b>Credo Documentation</b></h1>
 <p align="center">
   <a
     href="https://raw.githubusercontent.com/hyperledger/aries-framework-javascript/main/LICENSE"
@@ -19,10 +19,10 @@
 <p align="center">
   <a href="#getting-started">Getting started</a> &nbsp;|&nbsp;
   <a href="#contributing">Contributing</a> &nbsp;|&nbsp;
-  <a href="#license">License</a> 
+  <a href="#license">License</a>
 </p>
 
-Aries JavaScipt is an ecosystem of self-sovereign identity development tools, with [Aries Framework JavaScipt](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
 
@@ -31,21 +31,21 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta
 ### Installation
 
 ```
-$ yarn
+yarn
 ```
 
 ### Local Development
 
 ```
-$ yarn start
+yarn start
 ```
 
 This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
 
 ### Build
 
 ```
-$ yarn build
+yarn build
 ```
 
 This command generates static content into the `build` directory and can be served using any static contents hosting service.
@@ -55,23 +55,23 @@ This command generates static content into the `build` directory and can be serv
 Using SSH:
 
 ```
-$ USE_SSH=true yarn deploy
+USE_SSH=true yarn deploy
 ```
 
 Not using SSH:
 
 ```
-$ GIT_USER=<Your GitHub username> yarn deploy
+GIT_USER=<Your GitHub username> yarn deploy
 ```
 
 If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
 
 ## 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.
 
 ## Licence
 
-Aries JavaScript Documentation is licensed under the [Apache License Version 2.0 (Apache-2.0)](/LICENSE).
+Credo Documentation is licensed under the [Apache License Version 2.0 (Apache-2.0)](/LICENSE).
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -6,8 +6,8 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula')
 const remarkTabs = require('remark-docusaurus-tabs')
 /** @type {import('@docusaurus/types').Config} */
 const config = {
-  title: 'Aries JavaScript Documentation',
-  tagline: 'Everything you need to know about the Aries JavaScript ecosystem.',
+  title: 'Credo',
+  tagline: 'Everything you need to know about the Credo TS ecosystem.',
   url: 'https://credo.js.org',
   baseUrl: '/',
   onBrokenLinks: 'warn',
@@ -17,8 +17,8 @@ const config = {
 
   // GitHub pages deployment config.
   // If you aren't using GitHub pages, you don't need these.
-  organizationName: 'hyperledger', // Usually your GitHub org/user name.
-  projectName: 'aries-javascript-docs', // Usually your repo name.
+  organizationName: 'openwallet-foundation', // Usually your GitHub org/user name.
+  projectName: 'credo-ts-docs', // Usually your repo name.
   trailingSlash: false,
 
   // Even if you don't use internalization, you can use this field to set useful
@@ -45,11 +45,15 @@ const config = {
             tag: ':::',
             keywords: ['note', 'tip', 'info', 'caution', 'danger', 'issuer', 'verifier', 'holder', 'bob', 'acme'],
           },
-          lastVersion: 'current',
+          lastVersion: '0.4',
           versions: {
             current: {
+              label: 'v0.5.x',
+              path: '0.5',
+              banner: 'unreleased',
+            },
+            0.4: {
               label: 'v0.4.x',
-              path: '0.4',
             },
             0.3: {
               label: 'v0.3.x',
@@ -68,7 +72,7 @@ const config = {
     ({
       image: 'img/aries-social-preview-layered.png',
       navbar: {
-        title: 'Aries JavaScript Docs',
+        title: 'Credo Docs',
         logo: {
           alt: 'Hyperledger Aries Logo',
           src: 'img/aries-logo.png',
@@ -108,11 +112,7 @@ const config = {
             items: [
               {
                 label: 'Discord',
-                href: 'https://discord.com/channels/905194001349627914/941708033434738768',
-              },
-              {
-                label: 'Hyperledger Aries Mailing List',
-                href: 'https://lists.hyperledger.org/g/aries',
+                href: 'https://discord.com/channels/1022962884864643214/1179453305856991263',
               },
               {
                 label: 'Working Group Call Notes',
@@ -128,16 +128,16 @@ const config = {
             title: 'Repositories',
             items: [
               {
-                label: 'Aries Framework JavaScript',
-                href: 'https://github.com/hyperledger/aries-framework-javascript',
+                label: 'Credo',
+                href: 'https://github.com/openwallet-foundation/credo-ts',
               },
               {
-                label: 'Aries Framework JavaScript Extensions',
-                href: 'https://github.com/hyperledger/aries-framework-javascript-ext',
+                label: 'Credo Extensions',
+                href: 'https://github.com/openwallet-foundation/credo-ts-ext',
               },
               {
-                label: 'Aries JavaScript Docs (this site)',
-                href: 'https://github.com/hyperledger/aries-javascript-docs',
+                label: 'Credo Docs (this site)',
+                href: 'https://github.com/openwallet-foundation/credo-ts-docs',
               },
             ],
           },

diff --git a/guides/concepts/agents.md b/guides/concepts/agents.md
@@ -1,41 +1,41 @@
 # Agents
 
-When working with any Aries implementation, you will interact with an Aries
-agent. This will be either directly or via a REST API, like [the Aries
+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
 
-An Aries agent has three essential characteristics:
+An Credo agent has three essential characteristics:
 
 1. It acts as a fiduciary on behalf of a single identity owner (or, for agents
    of things like IoT devices, pets, and similar things, a single controller).
 1. It holds cryptographic keys that uniquely embody its delegated
    authorization.
 1. It interacts using interoperable DIDComm protocols, more on that later.
 
-What this means is that an Aries agent will act your behalf to issue create
+What this means is that an Credo agent will act your behalf to issue create
 connections, issue credentials, send messages etc. It also have a cryptographic
 toolkit with which it can uniquely, securely and verifiably operate. And lastly
 it interacts with other entities, this could be another agent, via [DIDComm
 protocols](https://identity.foundation/didcomm-messaging/spec/) later on. The
-Aries agent in the context of the Aries JavaScript ecosystem is your entry-point
+Credo agent in the context of the Credo ecosystem is your entry-point
 to all of the functionality.
 
 ### Categories
 
-There are many categories of Aries agents and we will group them into two
+There are many categories of Credo agents and we will group them into two
 categories; a mobile agent and a cloud agent. These agents are grouped based on
 their "location", e.g. a mobile wallet or server. Some other categories are a
-static, thin, thick and rich Aries agents. These agents are grouped based on
-their complexity instead of their "location". The Aries JavaScript ecosystem
+static, thin, thick and rich Credo agents. These agents are grouped based on
+their complexity instead of their "location". The Credo ecosystem
 allows you to create a mobile agent and a cloud agent. It also allows any of
 the complexity categorized agents.
 
 ### Examples
 
-Some examples of things that are Aries agent-like (since the definition can be
+Some examples of things that are Credo agent-like (since the definition can be
 bit loose, these examples might help to get a clearer picture):
 
 **A mobile wallet**
@@ -57,5 +57,3 @@ devices these can be used as a more central point for your data.
 
 - [Hyperledger Aries RFC - 004:
   Agents](https://github.com/hyperledger/aries-rfcs/blob/main/concepts/0004-agents/README.md)
-- [Aries Framework JavaScript - Getting
-  Started](https://github.com/hyperledger/aries-framework-javascript/tree/main/docs/getting-started)
diff --git a/guides/concepts/did-and-didcomm.md b/guides/concepts/did-and-didcomm.md
@@ -25,7 +25,7 @@ transport-agnostic, interoperable and much more. This means that you can
 securely send a message from as Alice to Bob securely via bluetooth, HTTP,
 WebSockets, etc.
 
-When working with the tools available inside the Aries JavaScript ecosystem,
+When working with the tools available inside the Credo ecosystem,
 deep knowledge of DIDComm is not required.
 
 ### Useful Resources

diff --git a/guides/concepts/platform-and-environment.md b/guides/concepts/platform-and-environment.md
@@ -1,3 +1,3 @@
 # Platform and Environment
 
-[Aries framework JavaScript](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 Aries Framework JavaScript. 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/ecosystem/index.md b/guides/ecosystem/index.md
@@ -1,42 +1,40 @@
-# The Aries JavaScript Ecosystem
+# The Credo Ecosystem
 
-The Aries JavaScript ecosystem includes various components that are spread across multiple repositories. In this section we'll go over what these components are and how the relate to one another.
+The Credo ecosystem includes various components that are spread across multiple repositories. In this section we'll go over what these components are and how the relate to one another.
 
 ## Repositories
 
-Currently, Aries JavaScript is composed out of three separate repositories:
+Currently, Credo is composed out of two separate repositories:
 
-1. [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript)
-2. [Aries Framework JavaScript Extensions](https://github.com/hyperledger/aries-framework-javascript-ext)
-3. [Aries Mobile Agent React Native (Bifold)](https://github.com/hyperledger/aries-mobile-agent-react-native)
+1. [Credo](https://github.com/openwallet-foundation/credo-ts)
+2. [Credo Extensions](https://github.com/openwallet-foundation/credo-ts-ext)
+
+In addition, there are several open-source applications and building blocks built on top of Credo. One example is [Aries Mobile Agent React Native (Bifold)](https://github.com/hyperledger/aries-mobile-agent-react-native), which is a white-label mobile wallet you can use to bootstrap your own custom wallet.
 
 ## Documentation
 
 You can find their documentation here:
 
-1. [Aries Framework JavaScript](https://credo.js.org/guides)
-2. [Aries Framework JavaScript Extensions](https://credo.js.org/guides/extensions)
-3. [Aries Mobile Agent React Native (Bifold)](https://github.com/hyperledger/aries-mobile-agent-react-native/blob/main/README.md)
+1. [Credo (core)](https://credo.js.org/guides)
+2. [Credo Extensions](https://credo.js.org/guides/extensions)
 
-### Aries Framework JavaScript
+### Credo
 
-Aries Framework JavaScript (AFJ) is at the core of the Aries JavaScript ecosystem. AFJ provides all the functionality related to cryptography, storage, messaging and more that is required
+Credo (core) is at the core of the Credo ecosystem. Credo provides all the functionality related to cryptography, storage, messaging and more that is required
 
-## Contributing in the Aries JS Ecosystem
+## Contributing in the Credo Ecosystem
 
 Consider attending our weekly meetings to become aware of the current development cadence.
 
-- [Aries Framework JS Meeting](https://wiki.hyperledger.org/display/ARIES/Framework+JS+Meetings)
-- [Aries Bifold Meeting](https://wiki.hyperledger.org/display/ARIES/Aries+Bifold+User+Group)
+- [Credo Working Group Meeting](https://github.com/openwallet-foundation/credo-ts/wiki/Meeting-Information)
 - [Aries Working Group Meeting](https://wiki.hyperledger.org/display/ARIES/Aries+Working+Group)
 
 ### Developer Contributions
 
 Each project maintains its own CONTRIBUTING guidance:
 
-- [AFJ CONTRIBUTING.md](https://github.com/hyperledger/aries-framework-javascript/blob/main/CONTRIBUTING.md)
-- [AFJ-Ext CONTRIBUTING.md](https://github.com/hyperledger/aries-framework-javascript-ext/blob/main/CONTRIBUTING.md)
-- [Aries Bifold CONTRIBUTING](https://github.com/hyperledger/aries-mobile-agent-react-native/blob/main/CONTRIBUTING)
+- [Credo CONTRIBUTING.md](https://github.com/openwallet-foundation/credo-ts/blob/main/CONTRIBUTING.md)
+- [Credo Extensions CONTRIBUTING.md](https://github.com/openwallet-foundation/credo-ts-ext/blob/main/CONTRIBUTING.md)
 
 Each project has a significant set of developer conventions, checklists, templates, and actions to provide guidance and boundaries for a contribution.
 Consider looking at previous issues and their corresponding PRs to get a sense of the latest.
diff --git a/guides/extensions/index.md b/guides/extensions/index.md
@@ -2,15 +2,15 @@ import DocCardList from '@theme/DocCardList';
 
 # Extensions
 
-Aries Framework JavaScript Extensions is an extensions repository to Aries Framework JavaScript (AFJ). It hosts libraries built on top of Aries Framework JavaScript that don't necessarily belong to the core of the project.
+Credo Extensions is an extensions repository to Credo. It hosts libraries built on top of Credo that don't necessarily belong to the core of the project.
 
-Currently, there are four packages in the extension repository. Example extension libraries include React Hooks for AFJ and a REST API wrapper.
+Currently, there are four packages in the extension repository. Example extension libraries include React Hooks for Credo and a REST API wrapper.
 
-| Package                                                                                                    | Version                                                                                                          | Description                                             |
-| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
-| [`@aries-framework/redux-store`](https://www.npmjs.com/package/@aries-framework/redux-store)               | ![@aries-framework/redux-store version](https://img.shields.io/npm/v/@aries-framework/redux-store)               | Redux toolkit wrapper around Aries Framework JavaScript |
-| [`@aries-framework/rest`](https://www.npmjs.com/package/@aries-framework/rest)                             | ![@aries-framework/rest version](https://img.shields.io/npm/v/@aries-framework/rest)                             | Rest endpoint wrapper for using your agent over HTTP    |
-| [`@aries-framework/react-hooks`](https://www.npmjs.com/package/@aries-framework/react-hooks)               | ![@aries-framework/react-hooks version](https://img.shields.io/npm/v/@aries-framework/react-hooks)               | React Hooks for data handling and agent interaction     |
-| [`@aries-framework/push-notifications`](https://www.npmjs.com/package/@aries-framework/push-notifications) | ![@aries-framework/push-notifications version](https://img.shields.io/npm/v/@aries-framework/push-notifications) | Push notification plugin for Aries Framework JavaScript |
+| Package                                                                                                    | Version                                                                                                          | Description                                          |
+| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
+| [`@aries-framework/redux-store`](https://www.npmjs.com/package/@aries-framework/redux-store)               | ![@aries-framework/redux-store version](https://img.shields.io/npm/v/@aries-framework/redux-store)               | Redux toolkit wrapper around Credo                   |
+| [`@aries-framework/rest`](https://www.npmjs.com/package/@aries-framework/rest)                             | ![@aries-framework/rest version](https://img.shields.io/npm/v/@aries-framework/rest)                             | Rest endpoint wrapper for using your agent over HTTP |
+| [`@aries-framework/react-hooks`](https://www.npmjs.com/package/@aries-framework/react-hooks)               | ![@aries-framework/react-hooks version](https://img.shields.io/npm/v/@aries-framework/react-hooks)               | React Hooks for data handling and agent interaction  |
+| [`@aries-framework/push-notifications`](https://www.npmjs.com/package/@aries-framework/push-notifications) | ![@aries-framework/push-notifications version](https://img.shields.io/npm/v/@aries-framework/push-notifications) | Push notification plugin for Credo                   |
 
 <DocCardList />
diff --git a/guides/extensions/push-notifications.md b/guides/extensions/push-notifications.md
@@ -1,6 +1,6 @@
 # Push Notifications
 
-The Push Notifications plugin package provides a way for you to register your APNs and Firebase push notification token at an agent, allowing you to use push notifications directly from AFJ.
+The Push Notifications plugin package provides a way for you to register your APNs and Firebase push notification token at an agent, allowing you to use push notifications directly from Credo.
 
 :::note