App Documentation

Enhance your app's user experience by adding a user guide and release notes!

The app documentation feature is newly released and is rapidly evolving. Stay tuned for more features.

App documentation enables you to provide valuable information to your users directly within the app interface. You can add a user guide for comprehensive instructions and release notes to keep users informed about updates. This feature helps improve user engagement and understanding of your app.

Read below for instructions on how to add and access app documentation.

Adding a User Guide

To add a user guide to your app, follow these steps:

Create a markdown file named USER_GUIDE.md in your project directory.
Write your user guide content using markdown formatting.
Deploy your app to Numerous.

Once completed, the user guide will be available to end users.

Adding Release Notes

You can also add release notes to keep your users informed about updates:

Create a markdown file named RELEASE_NOTES.md in your project directory.
Document your app's updates and changes using markdown.
Deploy your app to Numerous.

Once completed, the release notes will be accessible to end users.

You can customize the filenames for release notes and user guide in the numerous.toml file by setting: This allows you to use different filenames if desired.

release_notes = "release_notes.md"
user_guide = "user_guide.md"

Accessing Documentation (For End Users)

When users access your app through the Numerous platform UI, they can easily view the documentation:

Access your app from the app gallery.
Look for the documentation icon in the bottom right corner of the app interface.
Click the icon to open the documentation drawer.
The user guide will be displayed in the drawer.
To view release notes, click the "Release Notes" button in the documentation drawer.

The documentation feature provides a way for users to access important information about your app without leaving the interface.

Using Apps Organizations