HomeGuidesAPI ReferenceGraphQL
Submit Documentation FeedbackJoin Developer CommunityOptimizely GitHubOptimizely NuGetLog In

assets/

This topic describes the assets/ folder as it pertains to your application in Optimizely Connect Platform (OCP).

This folder contains your detailed store listing description in markdown format in store-assets/description.md.

logo.svg | icon.svg

You must provide logos and icons as svg. These are used for listing cards in the directory and for channel apps. The icon is used in the campaign flow when the channel is used.

directory/

overview.md

Prior to installing an app, users will be able to see the contents from this file in the Overview tab in the directory.

Best Practices

Include the following items in your overview:

  • What the app is used for
  • Benefits and screen shots of use cases
  • How to install and use
  • Data added/changed due to this application
  • Periodicity of imports (if applicable)

Format

The description.md supports GitHub-flavored markdown for formatting. To learn more, refer to the GFM documentation.

docs/

index.md

📘

Note

Provide instructions and key details about your app to end-users.

Sample

# Summary

# Installation
## Prerequisites

## Instructions

# Objects & Fields
## Objects
| Object Display Name | Object Name |
| --- | --- |
| Foo | foo |

## Fields
| Field Display Name | Field Name | Description |
| --- | --- | --- |
| Bar | bar | This field stores sentiment for product reviews. |

# Other Information

Details

The description.md file details how your app works and what it does. Recommended information to include:

  • What use cases your app can help accomplish
  • What objects & fields your app will create
  • Any prerequisites for app installation
  • Details about major version upgrades

Format

The description.md supports GitHub-flavored markdown for formatting. To learn more, refer to the GFM documentation.