Generate app documentation
Aim: Use Naia Build’s background documentation agents to automatically produce comprehensive technical documentation for your application, covering APIs, data structures, component flows, and logic, without interrupting your active development work.
Procedure
-
Open the Agents tab.
This gives you access to Naia’s specialized documentation agents. These agents are distinct from the Chat tab. They run autonomously in the background and do not compete with your active prompting session.
-
Trigger a documentation run.
Enable the documentation agent for your application.
Result: The agent begins analyzing your application’s structure (page, components, API connections, data models, and logic flows) and generating documentation automatically. You can continue working in the Chat tab or making manual edits while this runs.
-
Monitor via tab notifications.
Browser-based tab notifications will alert you when the documentation agent requires input or when its task is complete. You do not need to stay on the Agents tab. Switch to another part of the workspace and let the agent work in the background.
-
Review documentation in the live app editor.
When the agent completes, select View. The generated documentation is displayed in the respective documentation tab produced, for example, Data Flow, Documentation, and App Flow. These contain API reference tables, component inventories, data flow diagrams in text form, and technical overviews. Browse the documentation without leaving the workspace.
-
Request documentation via chat.
You can also trigger documentation generation via natural language prompts in the Chat tab, for example,
Generate a full technical overview of this application including all APIs, data models, and page flows.The output is produced in its own documentation tab in the live app editor. Use this approach when you need documentation on a specific area rather than the full application.
| Run documentation generation at the end of each significant development session (after scaffolding, after connecting data, and after debugging). Incremental documentation is easier to review than a single large document generated at the end of the project. |