feat: added basic extensions repo documentation (#78)

Signed-off-by: Jim Ezesinachi <[email protected]>
openwallet-foundation · Dec 1, 2022 · d985eca · d985eca
1 parent 9b3f5ff
commit d985eca
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 12 deletions.
diff --git a/guides/ecosystem/bifold.md b/guides/ecosystem/bifold.md
diff --git a/guides/ecosystem/extensions.md b/guides/ecosystem/extensions.md
diff --git a/guides/ecosystem/framework.md b/guides/ecosystem/framework.md
diff --git a/guides/ecosystem/index.md b/guides/ecosystem/index.md
@@ -18,16 +18,16 @@ Aries Framework JavaScript (AFJ) is at the core of the Aries JavaScript ecosyste
 
 Consider attending our weekly meetings to become aware of the current development cadence.
 
-- [Aires Framework JS Meeting](https://wiki.hyperledger.org/display/ARIES/Framework+JS+Meetings)
-- [Aires Bifold Meeting](https://wiki.hyperledger.org/display/ARIES/Aries+Bifold+User+Group)
+- [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)
 - [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)
+- [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)
 
 Each project has a significant set of developer conventions, checklists, templates, and actions to provide guidance and boundaries for a contribution.

diff --git a/guides/extensions/index.md b/guides/extensions/index.md
@@ -0,0 +1,12 @@
+# Aries Framework JavaScript 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.
+
+Currently, there a 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/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 |
diff --git a/sidebars.js b/sidebars.js
@@ -98,12 +98,8 @@ const sidebars = {
       link: { type: 'doc', id: 'updating/index' },
       items: ['updating/update-assistant', 'updating/versions/0.1-to-0.2'],
     },
-    {
-      type: 'category',
-      label: 'Ecosystem',
-      link: { type: 'doc', id: 'ecosystem/index' },
-      items: ['ecosystem/framework', 'ecosystem/extensions', 'ecosystem/bifold'],
-    },
+    'ecosystem/index',
+    'extensions/index',
   ],
 }