Skip to content

Commit

Permalink
DocsUpdate-423: Add Documentation for RoboRewsty
Browse files Browse the repository at this point in the history
  • Loading branch information
ashley-mspgeek authored and gitbook-bot committed Nov 19, 2023
1 parent a9a8363 commit c3ec9eb
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 7 deletions.
3 changes: 2 additions & 1 deletion SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@
* [Workflow Listeners (Completion Handlers)](documentation/workflows/workflow-listeners.md)
* [How to See Specific Workflow Results](documentation/workflows/how-to-see-specific-workflow-results.md)
* [Workflow Building Tips and Tricks](documentation/workflows/workflow-building-tips-and-tricks/README.md)
* [Workflow Notes](documentation/workflows/workflow-building-tips-and-tricks/workflow-notes.md)
* [Workflow Notes](documentation/workflows/workflow-building-tips-and-tricks/workflow-notes/README.md)
* [Documenting With RoboRewsty](documentation/workflows/workflow-building-tips-and-tricks/workflow-notes/documenting-with-roborewsty.md)
* [Multiselect](documentation/workflows/workflow-building-tips-and-tricks/multiselect.md)
* [Favorite Actions](documentation/workflows/workflow-building-tips-and-tricks/favorite-actions.md)
* [Forms](documentation/forms/README.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

Built into Rewst are features, keyboard shortcuts, and enhancements designed to make building and maintaining workflows easier. The following subpages detail how to use some of the enhancements that come with Rewst.

<table data-view="cards"><thead><tr><th align="center"></th><th align="center"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td align="center"><a href="workflow-notes.md"><strong>Workflow Notes</strong></a></td><td align="center">Document parts of your workflow with Notes</td><td><a href="workflow-notes.md">workflow-notes.md</a></td></tr><tr><td align="center"><a href="multiselect.md"><strong>Multiselect</strong></a></td><td align="center">Select more than one task to move or modify</td><td><a href="multiselect.md">multiselect.md</a></td></tr><tr><td align="center"><a href="https://app.gitbook.com/o/mdGoyUomPKsvu1TSazxc/s/AQQ1EHVcEsGKBPVHmiav/~/changes/134/documentation/workflows/workflow-building-tips-and-tricks/favorite-actions/~/details"><strong>Favorite Actions</strong></a></td><td align="center">Save your favorite actions and quickly add them to your workflow</td><td><a href="favorite-actions.md">favorite-actions.md</a></td></tr></tbody></table>
<table data-view="cards"><thead><tr><th align="center"></th><th align="center"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td align="center"><a href="workflow-notes/"><strong>Workflow Notes</strong></a></td><td align="center">Document parts of your workflow with Notes</td><td><a href="workflow-notes/">workflow-notes</a></td></tr><tr><td align="center"><a href="multiselect.md"><strong>Multiselect</strong></a></td><td align="center">Select more than one task to move or modify</td><td><a href="multiselect.md">multiselect.md</a></td></tr><tr><td align="center"><a href="https://app.gitbook.com/o/mdGoyUomPKsvu1TSazxc/s/AQQ1EHVcEsGKBPVHmiav/~/changes/134/documentation/workflows/workflow-building-tips-and-tricks/favorite-actions/~/details"><strong>Favorite Actions</strong></a></td><td align="center">Save your favorite actions and quickly add them to your workflow</td><td><a href="favorite-actions.md">favorite-actions.md</a></td></tr></tbody></table>
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ You can create notes by using the following methods:
1. **Right-click** the canvas and select _Add Note_.
2. **Press and hold** the `control` key and drag to create a note.

<figure><img src="../../../.gitbook/assets/creating-a-note.gif" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../../.gitbook/assets/creating-a-note.gif" alt=""><figcaption></figcaption></figure>

### Editing Notes

To edit a note's content, hover over the upper-right icon and click _Edit Note._

<figure><img src="../../../.gitbook/assets/editing-a-note.gif" alt=""><figcaption><p>Editing a Note</p></figcaption></figure>
<figure><img src="../../../../.gitbook/assets/editing-a-note.gif" alt=""><figcaption><p>Editing a Note</p></figcaption></figure>

### Moving Notes

Expand All @@ -25,4 +25,4 @@ To move notes, click and drag it to the desired location on the canvas.

To delete notes, right-click the note and select _Delete Note._

<figure><img src="../../../.gitbook/assets/delete-a-note.gif" alt=""><figcaption><p>Right-Click to Delete Notes</p></figcaption></figure>
<figure><img src="../../../../.gitbook/assets/delete-a-note.gif" alt=""><figcaption><p>Right-Click to Delete Notes</p></figcaption></figure>
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
description: >-
Effortlessly create high-quality documentation for your workflow actions
without getting caught up in details.
---

# Documenting With RoboRewsty

## Introduction

RoboRewsty is a powerful tool that simplifies the process of creating comprehensive documentation for your workflow tasks. It does all the analysis behind the scenes, so you can focus on building your workflow, and let RoboRewsty handle the documentation.&#x20;

### How RoboRewsty Works

RoboRewsty streamlines the documentation process by simplifying user interactions. Here's how it operates within your workflow:

1. **Task Organization**: While using a note in your workflow editor, you can wrap the note around any number of tasks. This acts as a container for the tasks you want to document.
2. **User Interaction**: In the note configuration, you'll find a convenient option called `Use RoboRewsty`. Simply click this option to trigger RoboRewsty's documentation generation process.
3. **Automatic Analysis**: RoboRewsty automatically analyzes the tasks contained within the note block. It understands their context and structure.
4. **Documentation Generation**: With your tasks and configuration in mind, RoboRewsty generates professional and user-friendly documentation. It ensures that the output is clear and well-structured.

### Response Inclusion

When using RoboRewsty, you can expect each documentation output to adhere to a specific format. This format ensures clarity and consistency in your documentation:

* **Task Overview**: Each documentation response begins with a clear and concise task overview. This provides users with a high-level understanding of the task's purpose and context.
* **Task's Expected Result**: Next, you'll find information about the expected outcome or result of the task. This section helps users understand the desired outcome when executing the task.
* **Any Crucial Factors**: If there are any special considerations or crucial factors to be aware of for the task, they will be included. This ensures that users have all the necessary information to perform the task successfully.

2 changes: 1 addition & 1 deletion updates/cs-and-training-updates/august-11th-2023.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Explore what new changes the Training team has made in the last week.
* Missing Integration Actions
* Missing Pages
* Add[ Tips and Tricks](../../documentation/workflows/workflow-building-tips-and-tricks/) Page for Building Workflows
* [Workflow Notes](../../documentation/workflows/workflow-building-tips-and-tricks/workflow-notes.md)
* [Workflow Notes](../../documentation/workflows/workflow-building-tips-and-tricks/workflow-notes/)
* [Multiselect](../../documentation/workflows/workflow-building-tips-and-tricks/multiselect.md)
* [Favorite Actions](../../documentation/workflows/workflow-building-tips-and-tricks/favorite-actions.md)

Expand Down
2 changes: 1 addition & 1 deletion updates/cs-and-training-updates/august-25th-2023.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Explore what new changes the Training team has made in the last week.
* Fixed the Workflow and Crate links on the [Rewst Terminology Page](../../cluck-university/getting-started/rewst-terminology.md).
* Fixed Broken links on [Actions in Rewst page](../../documentation/workflows/actions-in-rewst/).
* Fixed code snippet and formatting errors on the [Dynamic Options and Inputs page](../../documentation/forms/intro-to-forms.md).
* Removed broken links on the [Workflow Notes page](../../documentation/workflows/workflow-building-tips-and-tricks/workflow-notes.md).
* Removed broken links on the [Workflow Notes page](../../documentation/workflows/workflow-building-tips-and-tricks/workflow-notes/).
* Fixed Broken Rewst platform links on all integration setup pages.
* Various punctuation and formatting fixes on all the integration setup pages.

Expand Down

0 comments on commit c3ec9eb

Please sign in to comment.