Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

refactor: rename to Credo #143

Merged
merged 18 commits into from
Jan 29, 2024
Merged

refactor: rename to Credo #143

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
77e0d0b
docs: update package name
karimStekelenburg Jan 23, 2024
baba56c
feat: freeze v0.4 docs
karimStekelenburg Jan 23, 2024
c2e3432
feat: update config
karimStekelenburg Jan 23, 2024
cde1377
refactor: rename "Aries JavaScript"
karimStekelenburg Jan 23, 2024
b32a7cf
refactor: duplicate snippets for 0.4
karimStekelenburg Jan 23, 2024
e1decf6
refactor: rename various old name varients
karimStekelenburg Jan 23, 2024
cd9f2a8
Update docusaurus.config.js
karimStekelenburg Jan 25, 2024
c0b6969
Update docusaurus.config.js
karimStekelenburg Jan 25, 2024
021c47a
Update guides/ecosystem/index.md
karimStekelenburg Jan 25, 2024
607ae7b
docs: remove dead link
karimStekelenburg Jan 28, 2024
f728a1e
refactor: update links and text
karimStekelenburg Jan 28, 2024
721f731
Update guides/getting-started/set-up/index.md
karimStekelenburg Jan 28, 2024
c7b038c
build: set default to 0.4, mark 0.5 as unreleased
karimStekelenburg Jan 28, 2024
7b620b3
refactor: rename AFJ to Credo
karimStekelenburg Jan 29, 2024
eda148f
refactor: update repo links
karimStekelenburg Jan 29, 2024
13baba4
refactor: update docs and ext links
karimStekelenburg Jan 29, 2024
b607387
build: update snippets package name
karimStekelenburg Jan 29, 2024
106cf67
style: run prettier
karimStekelenburg Jan 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/documentation-request.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Documentation Request
description: File a request to document a specific functionality in the Aries JavaScript ecosystem.
title: '[Request]: '
labels: ['request']
description: File a request to document a specific functionality in the Credo ecosystem.
title: "[Request]: "
labels: ["request"]
body:
- type: markdown
attributes:
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/settings.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

repository:
name: credo-ts-docs
description: Extension libraries for Aries Framework JavaScript
description: Extension libraries for Credo
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Extension libraries for Credo
description: Documentation for Credo

homepage: https://github.com/openwallet-foundation/credo-ts-docs
default_branch: main
has_downloads: false
Expand Down
2 changes: 1 addition & 1 deletion MAINTAINERS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/hyperledger/aries-framework-javascript/blob/main/MAINTAINERS.md) in the Credo repository.
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Outdated link (i think we should do a find al on aries-framework-javascript and hyperledger as well

Expand Down Expand Up @@ -74,4 +74,4 @@ Issues are also welcomed as it gives us a good idea of the work still needing to

## 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).
33 changes: 16 additions & 17 deletions docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 TS',
karimStekelenburg marked this conversation as resolved.
Show resolved Hide resolved
tagline: 'Everything you need to know about the Credo TS ecosystem.',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
tagline: 'Everything you need to know about the Credo TS ecosystem.',
tagline: 'Everything you need to know about the Credo ecosystem.',

url: 'https://credo.js.org',
baseUrl: '/',
onBrokenLinks: 'warn',
Expand All @@ -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
Expand Down Expand Up @@ -48,8 +48,11 @@ const config = {
lastVersion: 'current',
versions: {
current: {
label: 'v0.5.x',
karimStekelenburg marked this conversation as resolved.
Show resolved Hide resolved
path: '0.5',
},
0.4: {
label: 'v0.4.x',
path: '0.4',
},
0.3: {
label: 'v0.3.x',
Expand All @@ -68,7 +71,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',
Expand Down Expand Up @@ -108,11 +111,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',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should point to wiki in github

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also working group calendar can be removed, we have the wiki that lists both (line below)

Expand All @@ -128,16 +127,16 @@ const config = {
title: 'Repositories',
items: [
{
label: 'Aries Framework JavaScript',
href: 'https://github.com/hyperledger/aries-framework-javascript',
label: 'Credo ',
karimStekelenburg marked this conversation as resolved.
Show resolved Hide resolved
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',
},
],
},
Expand Down
6 changes: 3 additions & 3 deletions guides/concepts/agents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ 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
Aries agent in the context of the Credo ecosystem is your entry-point
to all of the functionality.

### Categories
Expand All @@ -29,7 +29,7 @@ There are many categories of Aries 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
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.

Expand Down Expand Up @@ -57,5 +57,5 @@ 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
- [Credo - Getting
karimStekelenburg marked this conversation as resolved.
Show resolved Hide resolved
Started](https://github.com/hyperledger/aries-framework-javascript/tree/main/docs/getting-started)
2 changes: 1 addition & 1 deletion guides/concepts/did-and-didcomm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion guides/concepts/platform-and-environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/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.
18 changes: 9 additions & 9 deletions guides/ecosystem/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
# 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 three 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)
1. [Credo](https://github.com/hyperledger/aries-framework-javascript)
2. [Credo 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)

karimStekelenburg marked this conversation as resolved.
Show resolved Hide resolved
## 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)
1. [Credo](https://credo.js.org/guides)
2. [Credo 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)

### 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
Aries Framework JavaScript (AFJ) is at the core of the Credo ecosystem. AFJ provides all the functionality related to cryptography, storage, messaging and more that is required

karimStekelenburg marked this conversation as resolved.
Show resolved Hide resolved
## Contributing in the Aries JS Ecosystem

karimStekelenburg marked this conversation as resolved.
Show resolved Hide resolved
Expand Down
6 changes: 3 additions & 3 deletions guides/extensions/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

| 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/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 Aries Framework JavaScript |
| [`@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 />
2 changes: 1 addition & 1 deletion guides/extensions/rest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# REST API

The Aries Framework JavaScript (AFJ) REST API provides simple RESTful endpoints for AFJ methods, to allow you stand up an agent for communication over the internet instantly. You simply provide your agent configuration. The REST endpoints allow you to interact with your agent over HTTP and WebSockets.
The Credo REST API provides simple RESTful endpoints for AFJ methods, to allow you stand up an agent for communication over the internet instantly. You simply provide your agent configuration. The REST endpoints allow you to interact with your agent over HTTP and WebSockets.

The AFJ REST API is the most convenient way for self-sovereign identity (SSI) developers to interact with SSI agents.

Expand Down
2 changes: 1 addition & 1 deletion guides/getting-started/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import DocCardList from '@theme/DocCardList';

# Getting started

In this section we will go over everything you need to get started on a technical level. First there are some general prerequisites for Node.JS and React Native. Aries Framework JavaScript works for creating both server-side applications (commonly but not always for creating issuer and verifier agents) and mobile applications (commonly holder agents).
In this section we will go over everything you need to get started on a technical level. First there are some general prerequisites for Node.JS and React Native. Credo works for creating both server-side applications (commonly but not always for creating issuer and verifier agents) and mobile applications (commonly holder agents).

Based on the platform you want to work on, the installation guides you should follow are the same, but some steps may differ.

Expand Down
2 changes: 1 addition & 1 deletion guides/getting-started/prerequisites.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Prerequisites

To work with [Aries Framework JavaScript](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/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!

The specific items that we set-up:

Expand Down
4 changes: 2 additions & 2 deletions guides/getting-started/set-up/anoncreds-rs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

:::caution

Support for the AnonCreds RS library in Aries Framework JavaScript is currently experimental. We recommend new projects to use AnonCreds RS from the start, and also to migrate existing projects to AnonCreds, from the Indy Sdk. However, projects may experience some issues. If you encounter any issues, please [open an issue](https://github.com/hyperledger/aries-framework-javascript/issues/new).
Support for the AnonCreds RS library in Credo is currently experimental. We recommend new projects to use AnonCreds RS from the start, and also to migrate existing projects to AnonCreds, from the Indy Sdk. However, projects may experience some issues. If you encounter any issues, please [open an issue](https://github.com/hyperledger/aries-framework-javascript/issues/new).

Currently, there are few limitations to using AnonCreds RS.

Expand All @@ -15,7 +15,7 @@ Currently, there are few limitations to using AnonCreds RS.

### Installing AnonCreds RS

When using Aries Framework JavaScript with AnonCreds RS, there are a few extra dependencies that need to be installed. We need to install `@hyperledger/anoncreds` package, which contains the interfaces, and `@hyperledger/anoncreds-rs` package which is an implementation which depends on a wrapper of anoncreds-rs. Secondly, we need to add native bindings for the specific platform `@hyperledger/anoncreds-<platform>`. Currently there are bindings for Node.JS, as `@hyperledger/anoncreds-nodejs`, and React Native as `@hyperlegder/anoncreds-react-native`.
When using Credo with AnonCreds RS, there are a few extra dependencies that need to be installed. We need to install `@hyperledger/anoncreds` package, which contains the interfaces, and `@hyperledger/anoncreds-rs` package which is an implementation which depends on a wrapper of anoncreds-rs. Secondly, we need to add native bindings for the specific platform `@hyperledger/anoncreds-<platform>`. Currently there are bindings for Node.JS, as `@hyperledger/anoncreds-nodejs`, and React Native as `@hyperlegder/anoncreds-react-native`.

<!--tabs-->

Expand Down
4 changes: 2 additions & 2 deletions guides/getting-started/set-up/aries-askar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[Aries Askar](https://github.com/hyperledger/aries-askar) provides secure, encrypted storage and cryptographic support for encrypting, decrypting, signing and verifying data. It also provides both the `Wallet` and `StorageService` implementations for the agent.

:::caution
Although Aries Askar is stable and already used in production in agents such as [Aries Cloud Agent Python](https://github.com/hyperledger/aries-cloudagent-python), support for Aries Askar in Aries Framework JavaScript is currently experimental. We recommend new projects to use Aries Askar from the start, and also to migrate existing projects to Aries Askar. However, projects may experience some issues. If you encounter any issues, please [open an issue](https://github.com/hyperledger/aries-framework-javascript/issues/new).
Although Aries Askar is stable and already used in production in agents such as [Aries Cloud Agent Python](https://github.com/hyperledger/aries-cloudagent-python), support for Aries Askar in Credo is currently experimental. We recommend new projects to use Aries Askar from the start, and also to migrate existing projects to Aries Askar. However, projects may experience some issues. If you encounter any issues, please [open an issue](https://github.com/hyperledger/aries-framework-javascript/issues/new).

Currently, there are few limitations to using Aries Askar.

Expand All @@ -20,7 +20,7 @@ If you're upgrading from the Indy SDK to Aries Askar, see [Migrating from an Ind

### Installing Aries Askar

When using Aries Framework JavaScript with Aries Askar, there are a few extra dependencies that need to be installed. We need to install the `@aries-framework/askar` package, which implements the needed interfaces for the agent. Secondly, we need to add native bindings for the specific platform `@hyperledger/aries-askar-<platform>`. Currently there are bindings for Node.JS, as `@hyperledger/aries-askar-nodejs`, and React Native as `@hyperlegder/aries-askar-react-native`.
When using Credo with Aries Askar, there are a few extra dependencies that need to be installed. We need to install the `@aries-framework/askar` package, which implements the needed interfaces for the agent. Secondly, we need to add native bindings for the specific platform `@hyperledger/aries-askar-<platform>`. Currently there are bindings for Node.JS, as `@hyperledger/aries-askar-nodejs`, and React Native as `@hyperlegder/aries-askar-react-native`.

<!--tabs-->

Expand Down
2 changes: 1 addition & 1 deletion guides/getting-started/set-up/cheqd/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ cheqd also has a dedicated token, $CHEQ, used for identity writes to the network

### Installing cheqd

When using Aries Framework JavaScript with the cheqd, there's a few extra dependencies that need to be installed. We need to install the `@aries-framework/cheqd` package, which implements the needed interfaces for the agent.
When using Credo with the cheqd, there's a few extra dependencies that need to be installed. We need to install the `@aries-framework/cheqd` package, which implements the needed interfaces for the agent.

#### React Native

Expand Down
Loading
Loading