Write user documentation

Learn how to add user documentation to your apps.

Editor README

README files are a staple of any programming project. They provide the first introduction to a new codebase and help you share important project details with collaborators. All Retool apps include a built-in README file, which you can access by clicking the app's title in the toolbar.

Inside the Edit app details modal, there's an Editor README section. This text area accepts Markdown.

Content in the README is only visible to users with Edit or Own permissions on the app. When other editors open the Edit app details modal, they’ll see the rendered Markdown, along with the last editor to update the text and a timestamp. Editors can also edit the README themselves.

User documentation

If you're on a Business or Enterprise plan, you also have access to User documentation. This documentation is visible to your app’s users, and you can use it to explain how your app works or where to report issues.

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. User documentation can also be opened by clicking the documentation icon in the lower left corner.