assets/

The assets/ directory contains static content for your app's OCP App Directory listing.

The assets/logo.svg file is the icon or image that displays on your app card in the OCP App Directory. The recommended size is 150 x 50 px.

directory/overview.md

The content of the directory/overview.md file is rendered to the app's Overview tab, which is presented when a user clicks through to your app from the OCP App Directory.

Best Practices

Include the following items in your overview:

• What the app is used for
• Benefits and screenshots of use cases
• How to install and use the app
• Data that this app will add and change
• The frequency that this app imports or exports data

Format

The directory/overview.md supports GitHub-flavored markdown for formatting.