Skip to main content

Documentation

in Apps
Authors list
Paskelbta: 2022-06-01

When it comes time to publish your app, it will be necessary to inform the user:

  • What functionality your app provides

  • How to set up your app

These two pieces of information effectively drive the "Description" and "Setup" tabs in the apps admin drawer.

image.png

image.png

This content is contained within the following Markdown files in the root of the app package:

  • DESCRIPTION.md - contains content of the "Description" tab

  • SETUP.md - contains content of the "Setup" tab

For SETUP.md, it's a good idea to guide the user through the setup process. This may mean generating API keys or configuring permissions.

If you'd like to add images to these documents, create a docs/ directory in the root of your app project. Add the images to this directory and embed Markdown image tags where necessary:

![Image Alt](/docs/my-image.png)
copy
NaudingasNenaudingas
next pageBuilding and packaging an app
previous pageTesting

Please log in or register to submit a comment.