Skip to content

Commit 778261b

Browse files
authored
Update README.md
1 parent 100ec63 commit 778261b

1 file changed

Lines changed: 1 addition & 34 deletions

File tree

README.md

Lines changed: 1 addition & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -46,38 +46,5 @@ This repository includes two example projects:
4646
1. [fast-api and react](/fast-api-react): a full stack demo OpenAi chat application
4747
2. [simple-examples](/simple-examples): stand-alone workers showing off core functionality of hatchet
4848

49-
To get started, navigate to the respective example directories for further README instructions.
49+
To get started, navigate to the respective example directories for further README instructions and refer to the [Documentation](https://docs.hatchet.run/home/python-sdk/setup)
5050

51-
## Using the Playground
52-
53-
The Playground is a powerful feature within the Hatchet environment that allows you to experiment, develop, and test workflows interactively before deploying them into production. It is designed to offer a user-friendly interface where you can write, edit, and execute code steps that live within your code, as well as simulate and debug your workflows in a controlled setting. Here's how to get started:
54-
55-
### Accessing the Playground
56-
57-
1. **Sign In**: First, sign into your Hatchet dashboard.
58-
2. **Navigate to Workflows**: Look for the "Workflow" section in the navigation menu on the left side of your screen. Clicking this will display a list of your registered workflows.
59-
3. **Interact with Workflows**: Choose a workflow to explore. Then, select one of its runs to examine and interact with the inputs and outputs of specific steps within that workflow.
60-
61-
#### Features and How to Use Them
62-
63-
##### Input/Output View
64-
65-
- **Step Interaction**: Each step in a workflow is presented with a distinct input form and an output section for your review.
66-
- **Modifying Step Inputs**: You have the capability to adjust various components of a step's input:
67-
68-
###### Workflow Input
69-
70-
This is the initial data that triggers the workflow. You can modify this to test how different inputs affect the workflow.
71-
72-
###### Parent Data
73-
74-
These are the outputs from preceding steps in the workflow. You can view and modify these to understand how data flows through and affects subsequent steps.
75-
76-
###### Playground
77-
78-
Within each step of your workflow, there is a `context` parameter. This parameter features a unique method called `playground`, which accepts two arguments: a name (as a string) and a value (which must be a primitive data type). This functionality is designed to dynamically adjust certain aspects of your workflow on the fly. When you execute a step in the Playground, Hatchet recognizes any `playground` you've implemented, enabling you to modify them directly. This flexibility is especially useful for fine-tuning specific parameters, such as adjusting prompt instructions or other configurations.
79-
80-
###### Debugging
81-
82-
- **Error Identification and Resolution**: The Playground is equipped with debugging tools aimed at efficiently identifying and resolving errors within your workflows. It displays error messages and logs in the output section, providing clear insights into issues that need attention.
83-
- **Event Replay**: A future feature will allow for the replay of events within your local development environment. This means you'll be able to revisit specific events, make necessary code adjustments, and verify that errors have been effectively addressed, further enhancing the debugging process.

0 commit comments

Comments
 (0)