Publication dateMar 9, 2022
Confidentiality public Public
Generate technical doc markdown
TASK
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.
logout
Output
Markdown
The technical documentation of the brick in markdown format
settings
Configuration
The name of the brick to generate the technical documentation
Type : stringThe object type to generate the technical documentation
Type : stringAllowed values : Resource Task Protocol The separator to use between two object in the markdown file
Type : stringDefault value : [---]\nTechnical bricks to reuse or customize
Have you developed a brick?
Share it to accelerate projects for the entire community.
