Skip to main content

Add documentation to web apps

Learn how to add a README and user documentation to web apps.

You can add documentation to an app to provide guidance and context for other users.

Write a README​

README files are an important part of any programming project. Their purpose is to introduce the codebase to new users and help share important project details with collaborators. All Retool apps include a built-in README file for you to edit.

For web apps, access the README in the Pages tab. There are two methods to create a README:

  • Click Generate with AI to automatically generate a README based on the components and logic in your app.
  • Click anywhere on the README page and draft your README in Markdown.

When you're done, click Preview to view the rendered Markdown.

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

To regenerate the README with AI, delete all the content and click Generate with AI.

Write 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.