Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.prophecy.ai/llms.txt

Use this file to discover all available pages before exploring further.

Copilot Template Language (CTL) extends Markdown with special markers that create components in your documentation that standard Markdown doesn’t support. These markers enable features like interactive question forms, visual pipeline diagrams, and dynamic content that automatically updates based on your pipeline structure.

​
Marker syntax

Use CTL markers directly inside your documentation template Markdown file. Markers use this structure: 
[MARKER_TYPE]()
The MARKER_TYPE tells the Agent what type of special component to create. Each marker generates a specific type of component—like interactive forms, visual diagrams, or structured data tables—that standard Markdown cannot create on its own. For example, when the Agent comes across the [TRANSFORMATIONS]() marker in the template file, it will replace the marker with a formatted section listing all transformation steps in your pipeline in the generated documentation file. Each marker may accept zero, one, or multiple arguments. Review the specific marker to see its correct format.

​
Marker-template compatibility

This table describes which markers are compatible with which template types.
MarkerPipeline templatesProject templates
OVERVIEW✔✔
SOURCES✔
TARGETS✔
TRANSFORMATIONS✔
COPILOT_QUESTION✔✔
QUESTION✔✔
PIPELINES✔

​
Marker reference

The Copilot Template Language includes the following markers.

​
Overview

[OVERVIEW]()
The Agent-generated documentation will have a summary section of the pipeline or project. When the Agent generates the documentation for one pipeline specifically, it will embed an interactive visual diagram of the pipeline directly in the document.

​
Sources

[SOURCES]()
The Agent-generated documentation will have a formatted section that lists all data sources used in the pipeline, including descriptions and column information. This marker does not accept any parameters. This marker is compatible with pipeline-level templates only.

​
Targets

[TARGETS]()
The Agent-generated documentation will have a formatted section that lists all output tables or files created by the pipeline, including descriptions and column information. This marker does not accept any parameters. This marker is compatible with pipeline-level templates only.

​
Transformations

[TRANSFORMATIONS]()
The Agent-generated documentation will have a formatted section with a summary and detailed explanation of each data transformation step in the pipeline. This marker does not accept any parameters. This marker is compatible with pipeline-level templates only.

​
Copilot question

[COPILOT_QUESTION]('Your question here')
The Agent-generated documentation will have an interactive question form in your documentation. The Agent tries to answer the question automatically based on the pipeline or project. If the Agent can’t answer, the question appears as a form field for users to fill in after the documentation is generated. This marker accepts one string parameter that contains your question or prompt. For example: '[COPILOT_QUESTION]('Specify the number of transformation steps in the pipeline.')
The Agent will be able to answer most questions about the project and pipelines. It will not be able to answer questions that require additional context external to the project.

​
Question

[QUESTION]('Your question here')
The Agent-generated documentation will have an interactive question form in your documentation that users must answer manually. Unlike COPILOT_QUESTION, the Agent does not try to answer this question. It always appears as a form field for users to complete. This marker accepts one string parameter that contains your question or prompt. For example: '[QUESTION]('Define the expected outcome of this pipeline')

​
Pipelines

[PIPELINES](template=subtemplate.md)
The Agent will use a pipeline template to generate documentation and embed that documentation in the higher-level project documentation. The Agent processes the template separately for each pipeline, filling in the details specific to that pipeline. The template must already exist in the project for the Agent to locate it. To learn how to upload a new template, see Document pipelines.
The Agent can only generate one sub-document per marker. Use multiple pipeline markers to incorporate multiple pipeline documentation embeddings.