App Documentation

Every Foundry app can include documentation that is displayed to users in the App Catalog and within the app’s detail page.

Creating app docs

In the Falcon console

1. In the App Builder, go to Documentation.
2. Click Create doc.
3. Write your content using Markdown formatting.
4. Optionally upload images to embed in the documentation.
5. Save the document.

In the CLI

App documentation can be included as Markdown files in your app project. Reference them in manifest.yml:

docs:
  readme: docs/README.md

Content guidelines

App documentation should include:

• Overview — What the app does and what problem it solves
• Prerequisites — Required permissions, API keys, or external service accounts
• Configuration — Step-by-step setup instructions
• Usage — How to use the app’s features
• Troubleshooting — Common issues and their resolutions

Images

Upload images to include in your documentation:

1. In the documentation editor, click Upload image.
2. Select the image file.
3. Insert the image reference in your Markdown content.

Supported formats: PNG, JPEG, GIF.

Editing and deleting docs

• To edit, open the document in the App Builder and make changes.
• To delete, select the document and click Delete.

Documentation changes take effect after the next deployment and release.