# Document with RoboRewsty

{% hint style="info" %}
RoboRewsty has expanded! As of October 2025, our RoboRewsty capabilities now help you with knowledge search and product education. See our general page on RoboRewsty [here](/documentation/roborewsty.md) to learn more.

RoboRewsty is your go-to tool for simplifying the creation of comprehensive documentation for your workflow tasks. It takes care of the process behind the scenes, freeing you to focus on building your workflow while ensuring that the documentation is handled seamlessly.
{% endhint %}

## How does RoboRewsty work?

RoboRewsty integrates with the workflow builder canvas. It takes your workflows' JSON objects, and sends them to a private OpenAI Azure instance. The result is a quickly presented, well structured documentation breakdown of all selected tasks in your workflow.

{% hint style="warning" %}
RoboRewsty does not replace the existing note feature in the workflow builder. You can either add notes manually, or use RoboRewsty to help you do some of the heavy lifting.
{% endhint %}

## Use RoboRewsty

### Via workflow builder

1. Click <img src="/files/zNUXFxj4vmFE5PgLFNdT" alt="" data-size="line"> in the top toolbar of the workflow builder to start a note for the entire workflow. To add notes on specific elements, drag around an area on the canvas while holding down **ctrl + left click** , or **right click** and select **Add Note** within the workflow builder.\
   \
   ![](/files/LIOfQBm2IQY57zh8Mzrh)<br>
2. Click **Generate Auto-Documentation** to generate documentation for the entire workflow.\
   ![](/files/u8MKObqFKr2aXR5BJjvy)<br>
3. A waiting message will display while it runs on your workflow. This may take a moment, if your request holds a large number of tasks.\
   ![](/files/dmBoT45EeLOFmUm0MeAP)
4. View the notes generated in your **Notes** menu. Sections will include:
   1. **What's Occurring: Task Overview:** Each documentation response begins with a clear and concise overview, providing users with a high-level understanding of the task's purpose and context.
   2. **Expected Outcome: Task's Expected Result:** Information about the expected outcome or result of the task or group of tasks is presented. This section helps users anticipate the outcomes when the workflow executes the associated tasks.
   3. **Special Considerations: Any Crucial Factors:** Special considerations or crucial factors related to the tasks are included. These details ensure that users have all the necessary information to understand the workflow path successfully.
   4. An accordion list of all included tasks

<figure><img src="/files/8TfoO5b440wkDZBK3mbs" alt=""><figcaption><p>A completed RoboRewsty note</p></figcaption></figure>

### Via publish workflow

<figure><img src="/files/C5cdUaIeodWO4nqyVPIk" alt=""><figcaption></figcaption></figure>

RoboRewsty is also available to help when you publish a workflow. Click on the RoboRewst icon to generate a detailed change log, then **Submit**.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.rewst.help/documentation/roborewsty/document-with-roborewsty.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
