fix: some docs fixes

trywilco · Aug 20, 2024 · e1ae847 · e1ae847
1 parent 2a2da1f
commit e1ae847
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 16 deletions.
diff --git a/docs/building-your-quest/actions/github-reply-to-discussion.md b/docs/building-your-quest/actions/github-reply-to-discussion.md
@@ -16,7 +16,7 @@ Reply to a GitHub discussion.
 ## Params
 
 - **discussionNumber:** The discussion number. Can be used with the `github_discussion_created` trigger and the `${githubDiscussionNumber}` parameter.
-- **body:** The branch name in the quest's start repository. 
+- **body:** The content of the reply.
 
 ## Result
 

diff --git a/docs/building-your-quest/actions/github-repo-api.md b/docs/building-your-quest/actions/github-repo-api.md
@@ -16,14 +16,15 @@ A generic action to make a request to the GitHub repository API.
 ## Params
 
 - **method:** The HTTP method to use. Can be one of `get`, `post`, `patch`, `put`.
-- **body:** The body of the request.
+- **path:** The relative path of the repo API endpoint. For example, `/repos/{owner}/{repo}/contributors` will be `/contributors`.
+- **body:** The body of the API request.
 
 ## Result
 
 No additional info is added to the global payload outputs.
 
 ## Usage Example
-
+Enabling discussions on the repo :
 ```yaml
     - actionId: github_repo_api
       params:

diff --git a/docs/building-your-quest/triggers-and-payloads.md b/docs/building-your-quest/triggers-and-payloads.md
@@ -83,31 +83,31 @@ trigger:
 
 ### GITHUB_ISSUE_CREATED
 
-Triggered when the user creates an issue on their repository
+Triggered when the user creates an issue on their repository.
 
 ### GITHUB_BRANCH_CREATED
 
-Triggered when the user creates a remote branch on their repository
+Triggered when the user creates a remote branch on their repository.
 
 ### GITHUB_DISCUSSION_CREATED
 
-Triggered when the user creates a discussion on their repository
+Triggered when the user creates a discussion on their repository.
 
 Generated payload:
 
 - `githubDiscussionNumber`: the discussion number of the created discussion
 
 An example:
-    ```yml
-    trigger:
-      type: github_discussion_created
-      flowNode:
-        do:
-          - actionId: github_reply_to_discussion
-            params:
-              discussionNumber: "${githubDiscussionNumber}"
-              body: "Message body"
-    ```
+```yml
+trigger:
+  type: github_discussion_created
+  flowNode:
+    do:
+      - actionId: github_reply_to_discussion
+        params:
+          discussionNumber: "${githubDiscussionNumber}"
+          body: "Message body"
+```
 
 ### PING