create_documentation
Generate standardized documentation by extracting data from source files and applying customizable templates. Simplifies report creation for projects with structured outputs.
Instructions
Create documentation from source files using a template
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| output_path | No | Path where to save the generated documentation | |
| project_id | Yes | Project identifier (e.g., "JUVR058") | |
| sources | Yes | ||
| template_type | Yes | Type of documentation template to use (e.g., "CRISPRseq_Analysis") |
Input Schema (JSON Schema)
{
"properties": {
"output_path": {
"description": "Path where to save the generated documentation",
"type": "string"
},
"project_id": {
"description": "Project identifier (e.g., \"JUVR058\")",
"type": "string"
},
"sources": {
"items": {
"properties": {
"description": {
"description": "Brief description of the source",
"type": "string"
},
"type": {
"description": "Type of source file",
"enum": [
"presentation",
"script",
"code",
"reference"
],
"type": "string"
},
"url": {
"description": "URL or path to the source file",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"type": "array"
},
"template_type": {
"description": "Type of documentation template to use (e.g., \"CRISPRseq_Analysis\")",
"type": "string"
}
},
"required": [
"template_type",
"project_id",
"sources"
],
"type": "object"
}