Skip to content

Commit 192f75f

Browse files
committed
Update documentation for accuracy and consistency
- Clarified terminology in create-graph.md, changing "in this flow" to "in this graph." - Updated environment variable names in create-runtime.md for state manager URI and API key for better clarity. - Adjusted import statements in register-node.md to include BaseNode for improved context. - Standardized parameter naming in state-manager-setup.md by changing "api_key" to "key."
1 parent e21e85a commit 192f75f

4 files changed

Lines changed: 9 additions & 6 deletions

File tree

‎docs/docs/exosphere/create-graph.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Define the nodes in your workflow with their inputs and next nodes:
103103

104104
- **`node_name`**: The class name of the node (must be registered)
105105
- **`namespace`**: The namespace where the node is registered
106-
- **`identifier`**: Unique identifier for the node in this flow
106+
- **`identifier`**: Unique identifier for the node in this graph
107107
- **`inputs`**: Input values for the node
108108
- **`next_nodes`**: Array of node identifiers that this node connects to
109109

@@ -124,7 +124,7 @@ Use the `${{ ... }}` syntax to map outputs from previous nodes:
124124
**Mapping Syntax:**
125125

126126
- **`${{ node_identifier.outputs.field_name }}`**: Maps output from a specific node
127-
- **`initial`**: Static value provided when the flow is triggered
127+
- **`initial`**: Static value provided when the graph is triggered
128128
- **Direct values**: String values. In v1, numbers/booleans must be string-encoded (e.g., "42", "true").
129129
## Creating Graph Templates
130130

‎docs/docs/exosphere/create-runtime.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,8 @@ The `Runtime` class is the core component that manages the execution environment
7878

7979
### Optional Parameters
8080

81-
- **`state_manager_uri`** (str | None): URI of the state manager service. If not provided, uses `EXOSPHERE_URI` environment variable.
82-
- **`key`** (str | None): API key for authentication. If not provided, uses `EXOSPHERE_KEY` environment variable.
81+
- **`state_manager_uri`** (str | None): URI of the state manager service. If not provided, uses `EXOSPHERE_STATE_MANAGER_URI` environment variable.
82+
- **`key`** (str | None): API key for authentication. If not provided, uses `EXOSPHERE_API_KEY` environment variable.
8383
- **`batch_size`** (int): Number of states to fetch per poll. Defaults to 16.
8484
- **`workers`** (int): Number of concurrent worker threads. Defaults to 4.
8585
- **`state_manager_version`** (str): State manager API version. Defaults to "v0".

‎docs/docs/exosphere/register-node.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,9 @@ class Secrets(BaseModel):
6868
The runtime automatically validates your nodes:
6969

7070
```python hl_lines="19"
71+
from exospherehost import BaseNode
72+
from pydantic import BaseModel
73+
7174
# ✅ Valid node
7275
class ValidNode(BaseNode):
7376
class Inputs(BaseModel):
@@ -103,7 +106,7 @@ class InvalidNode(BaseNode):
103106
Nodes are automatically registered when you start your runtime:
104107

105108
```python hl_lines="14"
106-
from exospherehost import Runtime
109+
from exospherehost import Runtime, BaseNode
107110

108111
# Create your nodes
109112
class Node1(BaseNode):

‎docs/docs/exosphere/state-manager-setup.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ The state manager uri and key would be configured accordingly while setting up n
118118
name="YourWorkflow",
119119
nodes=[YourNodes],
120120
state_manager_uri="https://api.exosphere.host",
121-
api_key="your-production-api-key"
121+
key="your-production-api-key"
122122
).start()
123123
```
124124

0 commit comments

Comments
 (0)