Skip to main content

Documentation capabilities

Documentation in markdown​

For a lot of artifacts in Solution Designer e.g.

  • Workspace description
  • Projects
    • All project types:
      • Project overview documentation
    • Domain Service projects only:
      • Namespaces (API, Domain and Integration)
      • Entities (Root Entities, Entities and External Entities)
      • Services
      • Commands
      • Properties
      • Events
      • Agents
      • Errors
      • Operations

The section Documentation allows the user to easily write Markdown documentation. The text editor offers a WYSIWYG and a Markdown mode with live preview that supports both CommonMark and GFM specifications. The edit mode can be entered (only if the user has permission to edit the artefact) by clicking on the content or by using the symbol on the right top displayed while hovering over the content.

For each type of artefact a pre-defined structure is proposed and automatically displayed. More information is given on the specific type for which the diagram is available.

Visualize modelled elements in markdown​

You can easily create plantUML diagrams by either inserting native plantUML syntax in a codeblock or auto-generate a diagram by clicking on the "Insert diagram" button or using the k5 command.

For all kinds of diagrams the placeholder, ns has to be replaced with the name of the namespace that holds the object for which the diagram should be generated.

Project overview​

    solution api domain integration queue database all

This will generate the project overview diagram for the project you are currently working on.

Options:

  • api: Shows all api namespaces available in the current solution.
  • domain: Shows all Domain Namespaces available in the current solution.
  • integration: Shows all Integration Namespaces available in the current solution.
  • queue: Shows all messaging topics associated to their domain namespace.
  • database: Shows all database collections associated to their domain namespace.
  • all: Shows all api, domain and Integration Namespaces with their related massaging topics and database collections of the current solution.
ℹ️note

By using the command without any extension the default is to show the solution with its api, domain and Integration Namespaces.