Generate technical doc markdown - gws_core

Typing name : TASK.gws_core.GenerateTechnicalDocMarkdown

Brick : gws_core

Generate technical documentation of a brick as markdown

Generate technical documentation of a brick as markdown. This task takes the brick name as input and an object type (Resource, Task, Protocol) and returns the technical documentation of the brick in markdown format.

That markdown file can be use to train an AI model to learn about the brick functionalities.

Output

Markdown

The technical documentation of the brick in markdown format

File

Configuration

brick_name

The name of the brick to generate the technical documentation

Type : string

object_type

The object type to generate the technical documentation

Type : string

Allowed values : Resource Task Protocol

separator

Optional

The separator to use between two object in the markdown file

Type : string

Default value : [---]\n