Custom Help Toolkit

Microsoft has published a GitHub repository with scripts and tools that can help you prepare customized Help for your Business Central solution. This Help content can then be accessed from the user interface through the Learn more links as described in Configure Context-Sensitive Help. You are welcome to use any tools or processes to build and deploy content; this toolkit is intended to help you in some of the steps that are required.

Tip

You are not required to use the toolkit. It's available for you to use if it makes sense for your Business Central solution.

For example, if you deploy Business Central on-premises, you might want to set up a dedicated website with customer-specific content that includes customized content from Microsoft. However, Microsoft's content is optimized for the learn.microsoft.com site.

If your solution extends Business Central online with additional capabilities, we recommend that you set up a website with your own content. To build the HTML files, use any third-party tool that you prefer, such as DocFX.

The GitHub repository includes source code for the tools, and we welcome contributions and feedback to collaborate on improving the toolkit.

Tools in the toolkit

Important

The HTMLFromRepoGenerator tool is being deprecated. To generate HTML files from Markdown, use another tool, such as DocFX.

The language-specific repositories are also being deprecated, and will no longer be available at the end of the 2022 calendar year.

The toolkit is available at https://github.com/microsoft/dynamics365smb-custom-help. The repo contains the following tools as well as the source code for the tools:

Custom Help

Depending on your solution, you are expected to deploy Help to a website that can be accessed by users of your solution to supplement or replace Microsoft's content. For more information, see User Assistance Model and Configuring the Help Experience. The toolkit is especially useful if you deploy a customer-specific solution that is based on Microsoft's base application. If your solution extends Business Central online with additional capabilities, we recommend that you set up a website with your own content. To build the HTML files, use any third-party tool that you prefer, such as DocFX.

Tip

Microsoft's content in the various GitHub repos is optimized for the learn.microsoft.com site and the tools that are used for this site. We encourage you to supplement our content with solution-specific content as opposed to attempting to customize our content to fit your needs. But we acknowledge that there are situations when customizations are required, and the toolkit's tools can help you achieve that.

See also

Configure Context-Sensitive Help
User Assistance Model
Migrate Legacy Help to the Dynamics 365 Business Central Format
Extend and Collaborate on the Help for Dynamics 365 Business Central