Automatic App Documentation

Automatic App Documentation

Every AppSheet app consists of a unique combination of data sources, table structures, customized interfaces, variable formatting, various types of actions & workflows (and much more). These attributes are contained within the app’s ‘app definition’ that the app creator makes & maintains with the AppSheet Editor.

An exportable summary of each app definition is now available to app creators as a quick reference of the composition of each app. Visit ‘Info’ > ‘Properties’ > ‘App Documentation’ to access the documentation page for each app.

5 Likes

This is great.

I believe someone in the community was asking for a feature, a few months ago, to help identify all the places in an app a column or variable may be referenced.

This makes that possible with a quick ctrl+f

2 Likes

@Peter - Thanks to the team for working on this. Really helps to preserve a record and troubleshoot applications.

Two initial observations:

  1. Wish the major headers in the summary included hyperlinks to the sections for fast access (eg: Tables, Columns, Slices, Views, Format Rules, Actions, Workflows, Reports, etc).
  2. View Icon Name - it would help when reconstructing a view to know the name of the icon used (and not just show the icon). Since the icon list is now larger, can be tough to find the exact same icon again without the name.

image

Love the reformatted report. With so many pages, will need to use it a bit to provide other feedback…

1 Like

A great enhancement.

As I posted some time ago as an improvement recommendation it would also be handy to summarize tables, format rules etc that are redundant and not referenced or used in more complicated apps so the developer can use the summary to clean up the app to improve performance.

4 Likes

I assume AppSheet is using a PDF engine other than the one the apps use for reports. Are there any plans to extend this PDF engine to the app creators. One advantage I see with the documentation PDFs over those that can be created with apps is page header and footers. I would definitely appreciate being able to add headers and footers. Makes for a much more complete and polished report. Not to mention being able to keep order within the printed document.

@Peter