From a26c164c52c9c83c6e27449ea852e7de5512e309 Mon Sep 17 00:00:00 2001 From: Karim Stekelenburg Date: Mon, 29 Jan 2024 20:33:52 +0100 Subject: [PATCH 1/2] refactor: fixed various leftovers Signed-off-by: Karim Stekelenburg --- .github/settings.yml | 2 +- README.md | 6 +++--- docusaurus.config.js | 8 ++------ guides/concepts/agents.md | 3 +-- guides/extensions/index.md | 8 ++++---- guides/tutorials/agent-config/index.md | 11 ++++------- guides/tutorials/agent-config/logging.md | 2 +- 7 files changed, 16 insertions(+), 24 deletions(-) diff --git a/.github/settings.yml b/.github/settings.yml index 6821b19b..47db0c86 100644 --- a/.github/settings.yml +++ b/.github/settings.yml @@ -4,7 +4,7 @@ repository: name: credo-ts-docs - description: Extension libraries for Credo + description: Documentation for Credo homepage: https://github.com/openwallet-foundation/credo-ts-docs default_branch: main has_downloads: false diff --git a/README.md b/README.md index 9ce38c06..21951c94 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,14 @@
Hyperledger Aries logo

Credo Documentation

LicenseLicense

-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. +[Credo](https://github.com/openwallet-foundation/credo-ts) is a modular ecosystem of self-sovereign identity development tools written in TypeScript. 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 diff --git a/docusaurus.config.js b/docusaurus.config.js index f851b4c6..7a4e75bd 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -7,7 +7,7 @@ const remarkTabs = require('remark-docusaurus-tabs') /** @type {import('@docusaurus/types').Config} */ const config = { title: 'Credo', - 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', @@ -116,11 +116,7 @@ const config = { }, { label: 'Working Group Call Notes', - href: 'https://wiki.hyperledger.org/display/ARIES/Framework+JS+Meetings', - }, - { - label: 'Working Group Call Calendar', - href: 'https://lists.hyperledger.org/login?r=https%3A%2F%2Flists.hyperledger.org%2Fg%2Faries%2Fcalendar', + href: 'https://github.com/openwallet-foundation/credo-ts/wiki/Meeting-Information', }, ], }, diff --git a/guides/concepts/agents.md b/guides/concepts/agents.md index 1f6eb98c..81227107 100644 --- a/guides/concepts/agents.md +++ b/guides/concepts/agents.md @@ -1,8 +1,7 @@ # Agents 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 +agent. This will be either directly or via a REST API, like [the Credo REST API](https://github.com/openwallet-foundation/credo-ts-ext/tree/main/packages/rest). ### Characteristics diff --git a/guides/extensions/index.md b/guides/extensions/index.md index 84a906a4..a3834aec 100644 --- a/guides/extensions/index.md +++ b/guides/extensions/index.md @@ -8,9 +8,9 @@ Currently, there are four packages in the extension repository. Example extensio | 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 | +| [`@credo-ts/redux-store`](https://www.npmjs.com/package/@credo-ts/redux-store) | ![@credo-ts/redux-store version](https://img.shields.io/npm/v/@credo-ts/redux-store) | Redux toolkit wrapper around Credo | +| [`@credo-ts/rest`](https://www.npmjs.com/package/@credo-ts/rest) | ![@credo-ts/rest version](https://img.shields.io/npm/v/@credo-ts/rest) | Rest endpoint wrapper for using your agent over HTTP | +| [`@credo-ts/react-hooks`](https://www.npmjs.com/package/@credo-ts/react-hooks) | ![@credo-ts/react-hooks version](https://img.shields.io/npm/v/@credo-ts/react-hooks) | React Hooks for data handling and agent interaction | +| [`@credo-ts/push-notifications`](https://www.npmjs.com/package/@credo-ts/push-notifications) | ![@credo-ts/push-notifications version](https://img.shields.io/npm/v/@credo-ts/push-notifications) | Push notification plugin for Credo | diff --git a/guides/tutorials/agent-config/index.md b/guides/tutorials/agent-config/index.md index 9368bd40..b50429cc 100644 --- a/guides/tutorials/agent-config/index.md +++ b/guides/tutorials/agent-config/index.md @@ -1,8 +1,6 @@ # Agent Config -The Aries agent provided by [Aries Framework -JavaScript](https://github.com/openwallet-foundation/credo-ts) is very -extensible. These are all the configuration options with a short description: +The Credo agent is very extensible. These are all the configuration options with a short description: ## `label`\* @@ -127,7 +125,7 @@ that can be used for simple logs. See [Logging](./logging) for more details on c **Type**: `Logger` ```typescript title="example" -import { ConsoleLogger, LogLevel } from '@aries-framework/core' +import { ConsoleLogger, LogLevel } from '@credo-ts/core' logger: new ConsoleLogger(LogLevel.info) ``` @@ -155,7 +153,7 @@ much more ambiguous in their specification.     "application/didcomm-envelope-enc" ```typescript title="example" -import { DidCommMimeType } from '@aries-framework/core' +import { DidCommMimeType } from '@credo-ts/core' didCommMimeType: DidCommMimeType.V1 ``` @@ -207,8 +205,7 @@ connectionImageUrl: 'https://picsum.photos/200' ## `autoUpdateStorageOnStartup` Whether the storage should automatically be updated when a newer version of -[Aries Framework -JavaScript](https://github.com/openwallet-foundation/credo-ts) is used. +[Credo](https://github.com/openwallet-foundation/credo-ts) is used. **Type**: `boolean` diff --git a/guides/tutorials/agent-config/logging.md b/guides/tutorials/agent-config/logging.md index 5bdc762d..642dd8dd 100644 --- a/guides/tutorials/agent-config/logging.md +++ b/guides/tutorials/agent-config/logging.md @@ -84,4 +84,4 @@ agentDependencies.indy.setLogger((level, target, message, modulePath, file, line > WARNING: You can only set the logger once. Call indy_set_default_logger, indy_set_logger, not both. Once it's been set, libindy won't let you change it. You can also set the environment variable `RUST_LOG` to log at specified log levels. -See for more information. +See https://crates.io/crates/env_logger for more information. From c194d5e64ec8128154e9b05c2ed106474c674f7d Mon Sep 17 00:00:00 2001 From: Karim Stekelenburg Date: Mon, 29 Jan 2024 22:51:26 +0100 Subject: [PATCH 2/2] style: run prettier Signed-off-by: Karim Stekelenburg --- guides/extensions/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/guides/extensions/index.md b/guides/extensions/index.md index a3834aec..a361958b 100644 --- a/guides/extensions/index.md +++ b/guides/extensions/index.md @@ -6,8 +6,8 @@ Credo Extensions is an extensions repository to Credo. It hosts libraries built 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 | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | +| Package | Version | Description | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | | [`@credo-ts/redux-store`](https://www.npmjs.com/package/@credo-ts/redux-store) | ![@credo-ts/redux-store version](https://img.shields.io/npm/v/@credo-ts/redux-store) | Redux toolkit wrapper around Credo | | [`@credo-ts/rest`](https://www.npmjs.com/package/@credo-ts/rest) | ![@credo-ts/rest version](https://img.shields.io/npm/v/@credo-ts/rest) | Rest endpoint wrapper for using your agent over HTTP | | [`@credo-ts/react-hooks`](https://www.npmjs.com/package/@credo-ts/react-hooks) | ![@credo-ts/react-hooks version](https://img.shields.io/npm/v/@credo-ts/react-hooks) | React Hooks for data handling and agent interaction |