refactor: rename to Credo #143

karimStekelenburg · 2024-01-24T12:55:01Z

Todo

Freeze 0.4 versioned docs
Freeze 0.4 snippets
Rename all mentions of "Aries JavaScript" to "Credo"
Rename all mentions of "Aries Framework JavaScript" to "Credo"
Remove mentions of "AFJ"
Update repository links

Follow-up PR

Update logo
Update social preview
Edit home page and mention the project's history
Add blog functionality
Write and publish post about the rebranding

Signed-off-by: Karim Stekelenburg <[email protected]>

Renames all occurrences of "Aries JavaScript" to "Credo". > NOTE: this change is not applied to the directory. Signed-off-by: Karim Stekelenburg <[email protected]>

Signed-off-by: Karim Stekelenburg <[email protected]>

Replaces all occurrences of the following strings with "Credo" - Aries Framework JavaScript - Aries Framework JavaScript (AFJ) - Hyperledger Aries Framework JavaScript - Hyperledger Aries Framework JavaScript (AFJ) Regex pattern used: `\b(?:Hyperledger )?Aries Framework JavaScript(?: \(AFJ\))?` > NOTE: this change is not applied to the directory Signed-off-by: Karim Stekelenburg <[email protected]>

TimoGlastra

Just some small comments, see you weren't finished yet but these were all related to the items you marked as ✅

docusaurus.config.js

guides/concepts/agents.md

guides/ecosystem/index.md

guides/getting-started/set-up/index.md

Co-authored-by: Timo Glastra <[email protected]> Signed-off-by: Karim Stekelenburg <[email protected]>

Signed-off-by: Karim Stekelenburg <[email protected]>

Co-authored-by: Timo Glastra <[email protected]> Signed-off-by: Karim Stekelenburg <[email protected]>

Signed-off-by: Karim Stekelenburg <[email protected]>

TimoGlastra

Some small nits, but looks good! Going to merge already, can you do the other ones in a follow up?

TimoGlastra · 2024-01-29T17:40:56Z

.github/settings.yml

@@ -4,7 +4,7 @@

 repository:
  name: credo-ts-docs
-  description: Extension libraries for Aries Framework JavaScript
+  description: Extension libraries for Credo


Suggested change

description: Extension libraries for Credo

description: Documentation for Credo

TimoGlastra · 2024-01-29T17:41:52Z

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"


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

TimoGlastra · 2024-01-29T17:42:26Z

README.md

 </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.


Sentence doesn't make full sense anymore

TimoGlastra · 2024-01-29T17:43:02Z

docusaurus.config.js

-  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.',


Suggested change

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

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

TimoGlastra · 2024-01-29T17:43:53Z

docusaurus.config.js

-              {
-                label: 'Hyperledger Aries Mailing List',
-                href: 'https://lists.hyperledger.org/g/aries',
+                href: 'https://discord.com/channels/1022962884864643214/1179453305856991263',
              },
              {
                label: 'Working Group Call Notes',


Should point to wiki in github

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

TimoGlastra · 2024-01-29T17:45:37Z

guides/concepts/agents.md

-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


I'd remove framework -- just Credo REST Api

TimoGlastra · 2024-01-29T17:47:48Z

guides/extensions/index.md

-| [`@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                   |


I think we can also update the package names already . Or do you want to do it in a separate pr

TimoGlastra · 2024-01-29T17:49:08Z

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 https://crates.io/crates/env_logger for more information.
+See <https://crates.io/crates/env_logger> for more information.


Intentional?

TimoGlastra · 2024-01-29T17:49:59Z

guides/tutorials/agent-config/index.md

@@ -208,7 +208,7 @@ connectionImageUrl: 'https://picsum.photos/200'

 Whether the storage should automatically be updated when a newer version of
 [Aries Framework


karimStekelenburg added 6 commits January 23, 2024 20:32

docs: update package name

77e0d0b

Signed-off-by: Karim Stekelenburg <[email protected]>

feat: freeze v0.4 docs

baba56c

Signed-off-by: Karim Stekelenburg <[email protected]>

feat: update config

c2e3432

Signed-off-by: Karim Stekelenburg <[email protected]>

refactor: rename "Aries JavaScript"

cde1377

Renames all occurrences of "Aries JavaScript" to "Credo". > NOTE: this change is not applied to the directory. Signed-off-by: Karim Stekelenburg <[email protected]>

refactor: duplicate snippets for 0.4

b32a7cf

Signed-off-by: Karim Stekelenburg <[email protected]>

TimoGlastra reviewed Jan 25, 2024

View reviewed changes

karimStekelenburg and others added 11 commits January 25, 2024 12:39

Update docusaurus.config.js

cd9f2a8

Co-authored-by: Timo Glastra <[email protected]> Signed-off-by: Karim Stekelenburg <[email protected]>

Update docusaurus.config.js

c0b6969

Co-authored-by: Timo Glastra <[email protected]> Signed-off-by: Karim Stekelenburg <[email protected]>

Update guides/ecosystem/index.md

021c47a

Co-authored-by: Timo Glastra <[email protected]> Signed-off-by: Karim Stekelenburg <[email protected]>

docs: remove dead link

607ae7b

Signed-off-by: Karim Stekelenburg <[email protected]>

refactor: update links and text

f728a1e

Signed-off-by: Karim Stekelenburg <[email protected]>

Update guides/getting-started/set-up/index.md

721f731

Co-authored-by: Timo Glastra <[email protected]> Signed-off-by: Karim Stekelenburg <[email protected]>

build: set default to 0.4, mark 0.5 as unreleased

c7b038c

Signed-off-by: Karim Stekelenburg <[email protected]>

refactor: rename AFJ to Credo

7b620b3

Signed-off-by: Karim Stekelenburg <[email protected]>

refactor: update repo links

eda148f

Signed-off-by: Karim Stekelenburg <[email protected]>

refactor: update docs and ext links

13baba4

Signed-off-by: Karim Stekelenburg <[email protected]>

build: update snippets package name

b607387

Signed-off-by: Karim Stekelenburg <[email protected]>

karimStekelenburg marked this pull request as ready for review January 29, 2024 17:24

karimStekelenburg requested a review from TimoGlastra January 29, 2024 17:25

style: run prettier

106cf67

Signed-off-by: Karim Stekelenburg <[email protected]>

TimoGlastra approved these changes Jan 29, 2024

View reviewed changes

TimoGlastra merged commit 013aaf0 into openwallet-foundation:main Jan 29, 2024
2 checks passed

karimStekelenburg mentioned this pull request Jan 29, 2024

refactor: rename leftovers #144

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: rename to Credo #143

refactor: rename to Credo #143

karimStekelenburg commented Jan 24, 2024 •

edited

Loading

TimoGlastra left a comment

TimoGlastra left a comment

TimoGlastra Jan 29, 2024

TimoGlastra Jan 29, 2024

TimoGlastra Jan 29, 2024

TimoGlastra Jan 29, 2024

TimoGlastra Jan 29, 2024

TimoGlastra Jan 29, 2024

TimoGlastra Jan 29, 2024

TimoGlastra Jan 29, 2024

TimoGlastra Jan 29, 2024

TimoGlastra Jan 29, 2024

	description: Extension libraries for Credo
	description: Documentation for Credo

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

		@@ -208,7 +208,7 @@ connectionImageUrl: 'https://picsum.photos/200'

		Whether the storage should automatically be updated when a newer version of
		[Aries Framework

refactor: rename to Credo #143

refactor: rename to Credo #143

Conversation

karimStekelenburg commented Jan 24, 2024 • edited Loading

Todo

Follow-up PR

TimoGlastra left a comment

Choose a reason for hiding this comment

TimoGlastra left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

karimStekelenburg commented Jan 24, 2024 •

edited

Loading