Skip to content

Commit 53f9cea

Browse files
committed
doc: Fix links and update the readme
1 parent 0f58785 commit 53f9cea

1 file changed

Lines changed: 19 additions & 7 deletions

File tree

README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ fn star_added(login: String, repo: String) -> Result<(), String> {
2323
}
2424
```
2525

26-
Here is the complete [workflow source](./workflow/src/lib.rs) and the
27-
[WIT file](./workflow/interface/workflow.wit) describing the interface.
26+
Here is the complete [workflow source](./workflow/workflow-rs/src/lib.rs) and the
27+
[WIT file](./workflow/wit/deps/stargazers_workflow/workflow.wit) describing the interface.
2828

2929
[![Watch the Demo Video](assets/images/screencast.gif)](https://obeli.sk/screencast.webm)
3030

@@ -41,20 +41,32 @@ export TURSO_LOCATION="[yourdb].turso.io"
4141
```
4242

4343
#### Turso activity
44+
This activity is responsible for persistence of users and their generated descriptions.
45+
4446
Follow the prerequisites section of the [activity-db-turso README](./activity/db/turso/README.md).
4547

48+
#### GitHub activity
49+
This activity is used to find more information about the GitHub user who starred a configured repository.
50+
51+
Follow the prerequisites section of the [activity-github README](./activity/github/impl/README.md).
52+
4653
#### OpenAI activity
54+
Generates description based on user's repositories and organizations.
55+
4756
Follow the prerequisites section of the [activity-llm-openai README](./activity/llm/openai/README.md).
4857

4958
Reimplementation in [JavaScript](./activity/llm/openai-js/) and [Go](./activity/llm/openai-go/) is available for comparison.
5059

51-
#### GitHub activity
52-
Follow the prerequisites section of the [activity-github README](./activity/github/README.md).
53-
5460
#### GitHub webhook endpoint
55-
Follow the prerequisites section of the [webhook README](./webhook//README.md).
61+
The webhook collects events sent by GitHub when a user stars one of the configured repositories, then triggers the workflow execution.
62+
63+
Follow the prerequisites section of the [webhook README](./webhook/webhook-rs/README.md).
64+
Reimplementation in [JavaScript](./webhook/webhook-js/) and [Go](./webhook/webhook-go/) is available for comparison.
65+
66+
#### Workflow
67+
[Workflow](./workflow/workflow-rs/) orchestrates all the activities, is triggered by the webhook.
5668

57-
Reimplementation in [JavaScript](./activity/llm/openai-js/) is available for comparison.
69+
Reimplementation in [JavaScript](./workflow/workflow-js/) and [Go](./workflow/workflow-go/) is available for comparison.
5870

5971
### Running
6072

0 commit comments

Comments
 (0)