Tutorials

Publishing API reference for your .NET class library

It will be used to setup the credentials to your Aistant account in the configuration file for AistDoc (see below). Aistdoc utility scans your library assemblies and XML documentation files, generates articles (one article for each class, interface or enum) and uploads them to your knowledge base on Aistant. To generate a template for that file use the following command: Here -f (or --file ) parameter allows to specify the name of the config file and -m (or --mode ) specifies the mode (either ts for TypeScript or cs for C#). Here is an example of the configuration file (we suppose there that the team's ID is myteam and the knowledge base's ID is mykb ): The latest ( filter ) section of the config file contains a regular expression which filters necessary assemblies and/or namespaces The filter from the example above means that AistDoc takes all assemblies started with MyCompany.MyLibrary and will generate the docs for all classes with any namespace within those files. When the configuration file is ready you can start generation of the documents and uploading them to Aistant with the followng command: For example: AistDoc has an option which allows you to generate all articles locally - just to check how it works and how many documents you will have totally.

Publishing API reference for your TypeScript project with TSDoc

After that those generated files will be passed to AistDoc for publishing. Aistdoc is a .NET Core global tool, so its installation is quite simple: To update it to the latest version, if it was installed previously, use: TypeDoc utility will scan your TypeScript code and gather information about all code structures (modules, namespaces, classes, interfaces, enums, etc) to a special JSON file. It will be used to setup the credentials to your Aistant account in the configuration file for AistDoc (see below). To generate a template for that file use the following command: Here -f (or --file ) parameter allows to specify the name of the config file and -m (or --mode ) defines the mode (either ts for TypeScript or cs for C#). When the configuration file is ready you can start the publishing of your API reference to Aistant with the followng command: For example: That's all.