chore: minor package doc fixes (#183)

* chore: minor package doc fixes

* chore: fix example in ecommerce usage docs

* chore: add sentence to explain what the libraries actually implement

Author: andipaetzold

Diff for: packages/dam-app-base/README.md

@@ -4,6 +4,8 @@
 
 `@contentful/dam-app-base` is a library that helps you to quickly build an app to integrate your DAM (Digital Asset Management) system of choice with Contentful. Many DAM integrations are very similar, therefore this library provides the boilerplate for your app and you only need to add the code for your specific service.
 
+This library creates an app that can be used in the entry field location to select assets from your DAM service. The library also provides a configuration screen for easy customization.
+
 ## Usage
 
 ```javascript

Diff for: packages/dam-app-base/docs/README.md

@@ -86,7 +86,7 @@ You probably want to call [`sdk.openCurrentApp`](https://www.contentful.com/deve
 
 **`example`** 
 ```javascript
-function openDialog(sdk, currentValue, config) {
+async function openDialog(sdk, currentValue, config) {
   return await sdk.dialogs.openCurrentApp({
     parameters: { config, currentValue },
   });

Diff for: packages/dam-app-base/src/interfaces.ts

@@ -100,7 +100,7 @@ export type RenderDialogFn = (sdk: DialogExtensionSDK) => void;
  *
  * @example
  * ```javascript
- * function openDialog(sdk, currentValue, config) {
+ * async function openDialog(sdk, currentValue, config) {
  *   return await sdk.dialogs.openCurrentApp({
  *     parameters: { config, currentValue },
  *   });

Diff for: packages/ecommerce-app-base/README.md

@@ -4,6 +4,8 @@
 
 `@contentful/ecommerce-app-base` is a library that helps you to quickly build an app to integrate your e-commerce system of choice with Contentful. Many e-commerce integrations are very similar, therefore this library provides the boilerplate for your app and you only need to add the code for your specific service.
 
+This library creates an app which can be used in the entry field location to select stock keeping units (sku) from your e-commerce service. The library also provides a configuration screen for an easy customization.
+
 ## Usage
 
 ```javascript
@@ -30,7 +32,7 @@ setup({
           skus.map(sku => fetch(`https://example.com/products/${sku}`))
       );
       return responses.map(response => response.json());
-  }
+  },
   renderDialog: (sdk) => {
     const config = sdk.parameters.invocation;
 

Diff for: packages/ecommerce-app-base/docs/README.md

@@ -50,7 +50,7 @@ ___
 
 Function that should return true when the button should be disabled.
 
-**`param`** Currently selected assets
+**`param`** Currently selected skus
 
 **`param`** App configuration
 
@@ -74,13 +74,13 @@ ___
 
 Ƭ **OpenDialogFn**: (`sdk`: FieldExtensionSDK, `currentValue`: *string*[] \| *string*, `config`: [*Config*](README.md#config)) => *Promise*<*string*[]\>
 
-Function that gets called when app wants to open a dialog. Should return an updated list of assets as a Promise.
+Function that gets called when app wants to open a dialog. Should return an updated list of skus as a Promise.
 
 You probably want to call [`sdk.openCurrentApp`](https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#open-the-current-app-in-a-dialog).
 
 **`example`** 
 ```javascript
-function openDialog(sdk, currentValue, config) {
+async function openDialog(sdk, currentValue, config) {
   return await sdk.dialogs.openCurrentApp({
     parameters: { config, currentValue },
   });
@@ -90,11 +90,11 @@ function openDialog(sdk, currentValue, config) {
 
 **`param`** (https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/)
 
-**`param`** List of currently selected assets
+**`param`** List of currently selected akus
 
 **`param`** App configuration
 
-**`returns`** Promise containing a list of selected assets
+**`returns`** Promise containing a list of selected skus
 
 ___
 

Diff for: packages/ecommerce-app-base/docs/interfaces/integration.md

@@ -100,13 +100,13 @@ ___
 
 • **openDialog**: [*OpenDialogFn*](../README.md#opendialogfn)
 
-Function that gets called when app wants to open a dialog. Should return an updated list of assets as a Promise.
+Function that gets called when app wants to open a dialog. Should return an updated list of skus as a Promise.
 
 You probably want to call [`sdk.openCurrentApp`](https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#open-the-current-app-in-a-dialog).
 
 **`example`** 
 ```javascript
-function openDialog(sdk, currentValue, config) {
+async function openDialog(sdk, currentValue, config) {
   return await sdk.dialogs.openCurrentApp({
     parameters: { config, currentValue },
   });

Diff for: packages/ecommerce-app-base/src/interfaces.ts

@@ -114,13 +114,13 @@ export type DeleteFn = (index: number) => void;
 export type RenderDialogFn = (sdk: DialogExtensionSDK) => void;
 
 /**
- * Function that gets called when app wants to open a dialog. Should return an updated list of assets as a Promise.
+ * Function that gets called when app wants to open a dialog. Should return an updated list of skus as a Promise.
  *
  * You probably want to call [`sdk.openCurrentApp`](https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#open-the-current-app-in-a-dialog).
  *
  * @example
  * ```javascript
- * function openDialog(sdk, currentValue, config) {
+ * async function openDialog(sdk, currentValue, config) {
  *   return await sdk.dialogs.openCurrentApp({
  *     parameters: { config, currentValue },
  *   });
@@ -129,9 +129,9 @@ export type RenderDialogFn = (sdk: DialogExtensionSDK) => void;
  * ```
  *
  * @param sdk [FieldExtensionSDK](https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/)
- * @param currentValue List of currently selected assets
+ * @param currentValue List of currently selected akus
  * @param config App configuration
- * @returns Promise containing a list of selected assets
+ * @returns Promise containing a list of selected skus
  */
 export type OpenDialogFn = (
   sdk: FieldExtensionSDK,
@@ -142,7 +142,7 @@ export type OpenDialogFn = (
 /**
  * Function that should return true when the button should be disabled.
  *
- * @param currentValue Currently selected assets
+ * @param currentValue Currently selected skus
  * @param config App configuration
  * @returns true, if the button in the field location should be disabled. false, if the button should be enabled
  */
@@ -218,13 +218,13 @@ export interface Integration {
   renderDialog: RenderDialogFn;
 
   /**
-   * Function that gets called when app wants to open a dialog. Should return an updated list of assets as a Promise.
+   * Function that gets called when app wants to open a dialog. Should return an updated list of skus as a Promise.
    *
    * You probably want to call [`sdk.openCurrentApp`](https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#open-the-current-app-in-a-dialog).
    *
    * @example
    * ```javascript
-   * function openDialog(sdk, currentValue, config) {
+   * async function openDialog(sdk, currentValue, config) {
    *   return await sdk.dialogs.openCurrentApp({
    *     parameters: { config, currentValue },
    *   });