ALDoc tool

Path: Get started > Help and support > ALDoc tool · tier official · system none · narrative reviewed (checked by Opus)

Overview

ALDoc is a tool that builds reference documentation from the AL source code of Business Central apps. The output is a static website, produced with DocFx, and it reflects the structure of the application.

The section has two pages. The first, on generating help, explains the prerequisites (DocFx and .NET) and how to produce the reference documentation. The second, on overwriting help, explains how to create overwrite files that inject additional content into the autogenerated documentation without replacing what was generated.

Start with the generating page to get a working build. Then use the overwriting page when you need to add your own content, which involves docfx.json configuration and yml metadata tags.

Key points

• ALDoc generates reference documentation from AL source code for Business Central apps.
• Prerequisites include DocFx and .NET, which must be installed first.
• The output is a static website that reflects the application structure.
• Overwrite files inject additional content into autogenerated documentation.
• Overwriting adds content without replacing existing generated content.
• Overwrite setup involves docfx.json configuration and yml metadata tags.
• Read the generating page first, then the overwriting page.

Learn pages

• Generating help with the ALDoc tool: This article describes how to download and use the ALDoc tool to generate reference help for first party apps for Business Central.
• Overwriting help with the ALDoc tool: This article describes how to overwrite help content generated by the ALDoc tool for Business Central.

Source: Microsoft Learn (CC BY 4.0). Descriptions are Learn’s own.