Add documentation to mobile apps
Learn how to add a README and user documentation to mobile apps.
Write user documentation
| User documentation Availability | |||
|---|---|---|---|
| Cloud | Generally Available | ||
| Self-hosted Edge | Generally Available | ||
| Self-hosted Stable | Generally Available | ||
User documentation is visible to your app’s users, and you can use it to explain how your app works or where to report issues.
App editors can access user documentation by clicking the app's title in the toolbar. Inside the Edit app details modal, there's a User documentation section. This text area accepts Markdown.
You can also select Open automatically for new users to display the documentation modal the first time users open the app. Users can find the user documentation at any time by clicking the icon in the lower left corner of the viewport.