Skip to content

surfaced toolkit names #329

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
torresmateo merged 2 commits into from
Jun 18, 2025
Merged

surfaced toolkit names #329

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6a92aa7
surfaced toolkit names
torresmateo Jun 18, 2025
1b2122c
updated table of contents component and data
torresmateo Jun 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions pages/toolkits/development/code-sandbox.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ These tools are currently available in the Arcade Code Sandbox toolkit.
<TableOfContents
headers={["Tool Name", "Description"]}
data={[
["RunCode", "Run code in a sandboxed environment."],
["CreateStaticMatplotlibChart", "Create a static matplotlib chart."],
["CodeSandbox.RunCode", "Run code in a sandboxed environment."],
["CodeSandbox.CreateStaticMatplotlibChart", "Create a static matplotlib chart."],
]}
/>

Expand All @@ -39,7 +39,7 @@ These tools are currently available in the Arcade Code Sandbox toolkit.
own tools](/home/build-tools/create-a-toolkit).
</Tip>

## RunCode
## CodeSandbox.RunCode

<br />
<TabbedCodeBlock
Expand Down Expand Up @@ -70,7 +70,7 @@ Run code in a sandbox and return the output.

---

## CreateStaticMatplotlibChart
## CodeSandbox.CreateStaticMatplotlibChart

<br />
<TabbedCodeBlock
Expand Down
84 changes: 33 additions & 51 deletions pages/toolkits/development/github/github.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,40 +30,22 @@ These tools are currently available in the Arcade GitHub toolkit.
<TableOfContents
headers={["Tool Name", "Description"]}
data={[
["SetStarred", "Star or unstar a GitHub repository."],
["ListStargazers", "List the stargazers of a GitHub repository."],
["CreateIssue", "Create an issue in a GitHub repository."],
[
"CreateIssueComment",
"Create a comment on an issue in a GitHub repository.",
],
["ListPullRequests", "List pull requests in a GitHub repository."],
["GetPullRequest", "Get details of a pull request in a GitHub repository."],
["UpdatePullRequest", "Update a pull request in a GitHub repository."],
[
"ListPullRequestCommits",
"List commits on a pull request in a GitHub repository.",
],
[
"CreateReplyForReviewComment",
"Create a reply to a review comment on a pull request.",
],
[
"ListReviewCommentsOnPullRequest",
"List review comments on a pull request.",
],
["CreateReviewComment", "Create a review comment on a pull request."],
[
"CountStargazers",
"Count the number of stargazers for a GitHub repository.",
],
["ListOrgRepositories", "List repositories of a GitHub organization."],
["GetRepository", "Get details of a GitHub repository."],
["ListRepositoryActivities", "List activities of a GitHub repository."],
[
"ListReviewCommentsInARepository",
"List review comments in a repository.",
],
["Github.SetStarred", "Star or unstar a GitHub repository."],
["Github.ListStargazers", "List the stargazers of a GitHub repository."],
["Github.CreateIssue", "Create an issue in a GitHub repository."],
["Github.CreateIssueComment", "Create a comment on an issue in a GitHub repository.", ],
["Github.ListPullRequests", "List pull requests in a GitHub repository."],
["Github.GetPullRequest", "Get details of a pull request in a GitHub repository."],
["Github.UpdatePullRequest", "Update a pull request in a GitHub repository."],
["Github.ListPullRequestCommits", "List commits on a pull request in a GitHub repository.", ],
["Github.CreateReplyForReviewComment", "Create a reply to a review comment on a pull request.", ],
["Github.ListReviewCommentsOnPullRequest", "List review comments on a pull request.", ],
["Github.CreateReviewComment", "Create a review comment on a pull request."],
["Github.CountStargazers", "Count the number of stargazers for a GitHub repository.", ],
["Github.ListOrgRepositories", "List repositories of a GitHub organization."],
["Github.GetRepository", "Get details of a GitHub repository."],
["Github.ListRepositoryActivities", "List activities of a GitHub repository."],
["Github.ListReviewCommentsInARepository", "List review comments in a repository.", ],
]}
/>

Expand All @@ -74,7 +56,7 @@ These tools are currently available in the Arcade GitHub toolkit.
provider](/home/auth-providers/github#using-github-auth-in-customtools).
</Tip>

## SetStarred
## Github.SetStarred

<br />
<TabbedCodeBlock
Expand All @@ -101,7 +83,7 @@ Star or unstar a GitHub repository.

---

## ListStargazers
## Github.ListStargazers

<br />
<TabbedCodeBlock
Expand All @@ -128,7 +110,7 @@ List the stargazers of a GitHub repository.

---

## CreateIssue
## Github.CreateIssue

<br />
<TabbedCodeBlock
Expand Down Expand Up @@ -160,7 +142,7 @@ Create an issue in a GitHub repository.

---

## CreateIssueComment
## Github.CreateIssueComment

<br />
<TabbedCodeBlock
Expand Down Expand Up @@ -189,7 +171,7 @@ Create a comment on an issue in a GitHub repository.

---

## ListPullRequests
## Github.ListPullRequests

<br />
<TabbedCodeBlock
Expand Down Expand Up @@ -223,7 +205,7 @@ List pull requests in a GitHub repository.

---

## GetPullRequest
## Github.GetPullRequest

<br />
<TabbedCodeBlock
Expand Down Expand Up @@ -252,7 +234,7 @@ Get details of a pull request in a GitHub repository.

---

## UpdatePullRequest
## Github.UpdatePullRequest

<br />
<TabbedCodeBlock
Expand Down Expand Up @@ -284,7 +266,7 @@ Update a pull request in a GitHub repository.

---

## ListPullRequestCommits
## Github.ListPullRequestCommits

<br />
<TabbedCodeBlock
Expand Down Expand Up @@ -314,7 +296,7 @@ List commits (from oldest to newest) on a pull request in a GitHub repository.

---

## CreateReplyForReviewComment
## Github.CreateReplyForReviewComment

<br />
<TabbedCodeBlock
Expand Down Expand Up @@ -343,7 +325,7 @@ Create a reply to a review comment for a pull request in a GitHub repository.

---

## ListReviewCommentsOnPullRequest
## Github.ListReviewCommentsOnPullRequest

<br />
<TabbedCodeBlock
Expand Down Expand Up @@ -376,7 +358,7 @@ List review comments on a pull request in a GitHub repository.

---

## CreateReviewComment
## Github.CreateReviewComment

<br />
<TabbedCodeBlock
Expand Down Expand Up @@ -414,7 +396,7 @@ If the subject_type is not 'file', then the start_line and end_line parameters a

---

## CountStargazers
## Github.CountStargazers

<br />
<TabbedCodeBlock
Expand All @@ -440,7 +422,7 @@ Count the number of stargazers (stars) for a GitHub repository.

---

## ListOrgRepositories
## Github.ListOrgRepositories

<br />
<TabbedCodeBlock
Expand Down Expand Up @@ -471,7 +453,7 @@ List repositories for the specified GitHub organization.

---

## GetRepository
## Github.GetRepository

<br />
<TabbedCodeBlock
Expand All @@ -498,7 +480,7 @@ Get detailed information about a GitHub repository.

---

## ListRepositoryActivities
## Github.ListRepositoryActivities

<br />
<TabbedCodeBlock
Expand Down Expand Up @@ -533,7 +515,7 @@ List repository activities such as pushes, merges, force pushes, and branch chan

---

## ListReviewCommentsInARepository
## Github.ListReviewCommentsInARepository

<br />
<TabbedCodeBlock
Expand Down Expand Up @@ -573,4 +555,4 @@ With the hosted Arcade Engine, there's nothing to configure. Your users will see

With a self-hosted installation of Arcade, you need to [configure the GitHub auth provider](/home/auth-providers/github#configuring-github-auth) with your own GitHub app credentials.

<ToolFooter pipPackageName="arcade_github" />
<ToolFooter pipPackageName="arcade_github" />
29 changes: 13 additions & 16 deletions pages/toolkits/development/web/web.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,12 @@ These tools are currently available in the Arcade Web toolkit.
<TableOfContents
headers={["Tool Name", "Description"]}
data={[
["ScrapeUrl", "Scrape a URL and return data in specified formats."],
["CrawlWebsite", "Crawl a website and return crawl status and data."],
["GetCrawlStatus", "Retrieve the status of a crawl job."],
["GetCrawlData", "Retrieve data from a completed crawl job."],
["CancelCrawl", "Cancel an ongoing crawl job."],
[
"MapWebsite",
"Map a website from a single URL to a map of the entire website.",
],
["Web.ScrapeUrl", "Scrape a URL and return data in specified formats."],
["Web.CrawlWebsite", "Crawl a website and return crawl status and data."],
["Web.GetCrawlStatus", "Retrieve the status of a crawl job."],
["Web.GetCrawlData", "Retrieve data from a completed crawl job."],
["Web.CancelCrawl", "Cancel an ongoing crawl job."],
["Web.MapWebsite", "Map a website from a single URL to a map of the entire website.", ],
]}
/>

Expand All @@ -49,7 +46,7 @@ These tools are currently available in the Arcade Web toolkit.
own tools](/home/build-tools/create-a-toolkit).
</Tip>

## ScrapeUrl
## Web.ScrapeUrl

<br />
<TabbedCodeBlock
Expand Down Expand Up @@ -87,7 +84,7 @@ Scrape a URL and return data in specified formats.

---

## CrawlWebsite
## Web.CrawlWebsite

<br />
<TabbedCodeBlock
Expand Down Expand Up @@ -128,7 +125,7 @@ Crawl a website and return crawl status and data.

---

## GetCrawlStatus
## Web.GetCrawlStatus

<br />
<TabbedCodeBlock
Expand Down Expand Up @@ -160,7 +157,7 @@ Retrieve the status of a crawl job.

---

## GetCrawlData
## Web.GetCrawlData

<br />
<TabbedCodeBlock
Expand Down Expand Up @@ -192,7 +189,7 @@ Retrieve data from a completed crawl job.

---

## CancelCrawl
## Web.CancelCrawl

<br />
<TabbedCodeBlock
Expand Down Expand Up @@ -224,7 +221,7 @@ Cancel an ongoing crawl job.

---

## MapWebsite
## Web.MapWebsite

<br />
<TabbedCodeBlock
Expand Down Expand Up @@ -266,4 +263,4 @@ The Arcade Web toolkit uses [Firecrawl](https://www.firecrawl.dev/) to scrape, c

- `FIRECRAWL_API_KEY`: Your [Firecrawl](https://www.firecrawl.dev/) API key.

<ToolFooter pipPackageName="arcade_web" />
<ToolFooter pipPackageName="arcade_web" />
Loading