Skip to content

Commit fb8edd9

Browse files
torresmateotorresmateo
authored
surfaced toolkit names (#329)
* surfaced toolkit names * updated table of contents component and data
1 parent ccaf0f8 commit fb8edd9

36 files changed

+449
-516
lines changed

‎pages/toolkits/development/code-sandbox.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ These tools are currently available in the Arcade Code Sandbox toolkit.
2828
<TableOfContents
2929
headers={["Tool Name", "Description"]}
3030
data={[
31-
["RunCode", "Run code in a sandboxed environment."],
32-
["CreateStaticMatplotlibChart", "Create a static matplotlib chart."],
31+
["CodeSandbox.RunCode", "Run code in a sandboxed environment."],
32+
["CodeSandbox.CreateStaticMatplotlibChart", "Create a static matplotlib chart."],
3333
]}
3434
/>
3535

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

42-
## RunCode
42+
## CodeSandbox.RunCode
4343

4444
<br />
4545
<TabbedCodeBlock
@@ -70,7 +70,7 @@ Run code in a sandbox and return the output.
7070

7171
---
7272

73-
## CreateStaticMatplotlibChart
73+
## CodeSandbox.CreateStaticMatplotlibChart
7474

7575
<br />
7676
<TabbedCodeBlock

‎pages/toolkits/development/github/github.mdx‎

Lines changed: 33 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -30,40 +30,22 @@ These tools are currently available in the Arcade GitHub toolkit.
3030
<TableOfContents
3131
headers={["Tool Name", "Description"]}
3232
data={[
33-
["SetStarred", "Star or unstar a GitHub repository."],
34-
["ListStargazers", "List the stargazers of a GitHub repository."],
35-
["CreateIssue", "Create an issue in a GitHub repository."],
36-
[
37-
"CreateIssueComment",
38-
"Create a comment on an issue in a GitHub repository.",
39-
],
40-
["ListPullRequests", "List pull requests in a GitHub repository."],
41-
["GetPullRequest", "Get details of a pull request in a GitHub repository."],
42-
["UpdatePullRequest", "Update a pull request in a GitHub repository."],
43-
[
44-
"ListPullRequestCommits",
45-
"List commits on a pull request in a GitHub repository.",
46-
],
47-
[
48-
"CreateReplyForReviewComment",
49-
"Create a reply to a review comment on a pull request.",
50-
],
51-
[
52-
"ListReviewCommentsOnPullRequest",
53-
"List review comments on a pull request.",
54-
],
55-
["CreateReviewComment", "Create a review comment on a pull request."],
56-
[
57-
"CountStargazers",
58-
"Count the number of stargazers for a GitHub repository.",
59-
],
60-
["ListOrgRepositories", "List repositories of a GitHub organization."],
61-
["GetRepository", "Get details of a GitHub repository."],
62-
["ListRepositoryActivities", "List activities of a GitHub repository."],
63-
[
64-
"ListReviewCommentsInARepository",
65-
"List review comments in a repository.",
66-
],
33+
["Github.SetStarred", "Star or unstar a GitHub repository."],
34+
["Github.ListStargazers", "List the stargazers of a GitHub repository."],
35+
["Github.CreateIssue", "Create an issue in a GitHub repository."],
36+
["Github.CreateIssueComment", "Create a comment on an issue in a GitHub repository.", ],
37+
["Github.ListPullRequests", "List pull requests in a GitHub repository."],
38+
["Github.GetPullRequest", "Get details of a pull request in a GitHub repository."],
39+
["Github.UpdatePullRequest", "Update a pull request in a GitHub repository."],
40+
["Github.ListPullRequestCommits", "List commits on a pull request in a GitHub repository.", ],
41+
["Github.CreateReplyForReviewComment", "Create a reply to a review comment on a pull request.", ],
42+
["Github.ListReviewCommentsOnPullRequest", "List review comments on a pull request.", ],
43+
["Github.CreateReviewComment", "Create a review comment on a pull request."],
44+
["Github.CountStargazers", "Count the number of stargazers for a GitHub repository.", ],
45+
["Github.ListOrgRepositories", "List repositories of a GitHub organization."],
46+
["Github.GetRepository", "Get details of a GitHub repository."],
47+
["Github.ListRepositoryActivities", "List activities of a GitHub repository."],
48+
["Github.ListReviewCommentsInARepository", "List review comments in a repository.", ],
6749
]}
6850
/>
6951

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

77-
## SetStarred
59+
## Github.SetStarred
7860

7961
<br />
8062
<TabbedCodeBlock
@@ -101,7 +83,7 @@ Star or unstar a GitHub repository.
10183

10284
---
10385

104-
## ListStargazers
86+
## Github.ListStargazers
10587

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

129111
---
130112

131-
## CreateIssue
113+
## Github.CreateIssue
132114

133115
<br />
134116
<TabbedCodeBlock
@@ -160,7 +142,7 @@ Create an issue in a GitHub repository.
160142

161143
---
162144

163-
## CreateIssueComment
145+
## Github.CreateIssueComment
164146

165147
<br />
166148
<TabbedCodeBlock
@@ -189,7 +171,7 @@ Create a comment on an issue in a GitHub repository.
189171

190172
---
191173

192-
## ListPullRequests
174+
## Github.ListPullRequests
193175

194176
<br />
195177
<TabbedCodeBlock
@@ -223,7 +205,7 @@ List pull requests in a GitHub repository.
223205

224206
---
225207

226-
## GetPullRequest
208+
## Github.GetPullRequest
227209

228210
<br />
229211
<TabbedCodeBlock
@@ -252,7 +234,7 @@ Get details of a pull request in a GitHub repository.
252234

253235
---
254236

255-
## UpdatePullRequest
237+
## Github.UpdatePullRequest
256238

257239
<br />
258240
<TabbedCodeBlock
@@ -284,7 +266,7 @@ Update a pull request in a GitHub repository.
284266

285267
---
286268

287-
## ListPullRequestCommits
269+
## Github.ListPullRequestCommits
288270

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

315297
---
316298

317-
## CreateReplyForReviewComment
299+
## Github.CreateReplyForReviewComment
318300

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

344326
---
345327

346-
## ListReviewCommentsOnPullRequest
328+
## Github.ListReviewCommentsOnPullRequest
347329

348330
<br />
349331
<TabbedCodeBlock
@@ -376,7 +358,7 @@ List review comments on a pull request in a GitHub repository.
376358

377359
---
378360

379-
## CreateReviewComment
361+
## Github.CreateReviewComment
380362

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

415397
---
416398

417-
## CountStargazers
399+
## Github.CountStargazers
418400

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

441423
---
442424

443-
## ListOrgRepositories
425+
## Github.ListOrgRepositories
444426

445427
<br />
446428
<TabbedCodeBlock
@@ -471,7 +453,7 @@ List repositories for the specified GitHub organization.
471453

472454
---
473455

474-
## GetRepository
456+
## Github.GetRepository
475457

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

499481
---
500482

501-
## ListRepositoryActivities
483+
## Github.ListRepositoryActivities
502484

503485
<br />
504486
<TabbedCodeBlock
@@ -533,7 +515,7 @@ List repository activities such as pushes, merges, force pushes, and branch chan
533515

534516
---
535517

536-
## ListReviewCommentsInARepository
518+
## Github.ListReviewCommentsInARepository
537519

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

574556
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.
575557

576-
<ToolFooter pipPackageName="arcade_github" />
558+
<ToolFooter pipPackageName="arcade_github" />

‎pages/toolkits/development/web/web.mdx‎

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,12 @@ These tools are currently available in the Arcade Web toolkit.
3131
<TableOfContents
3232
headers={["Tool Name", "Description"]}
3333
data={[
34-
["ScrapeUrl", "Scrape a URL and return data in specified formats."],
35-
["CrawlWebsite", "Crawl a website and return crawl status and data."],
36-
["GetCrawlStatus", "Retrieve the status of a crawl job."],
37-
["GetCrawlData", "Retrieve data from a completed crawl job."],
38-
["CancelCrawl", "Cancel an ongoing crawl job."],
39-
[
40-
"MapWebsite",
41-
"Map a website from a single URL to a map of the entire website.",
42-
],
34+
["Web.ScrapeUrl", "Scrape a URL and return data in specified formats."],
35+
["Web.CrawlWebsite", "Crawl a website and return crawl status and data."],
36+
["Web.GetCrawlStatus", "Retrieve the status of a crawl job."],
37+
["Web.GetCrawlData", "Retrieve data from a completed crawl job."],
38+
["Web.CancelCrawl", "Cancel an ongoing crawl job."],
39+
["Web.MapWebsite", "Map a website from a single URL to a map of the entire website.", ],
4340
]}
4441
/>
4542

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

52-
## ScrapeUrl
49+
## Web.ScrapeUrl
5350

5451
<br />
5552
<TabbedCodeBlock
@@ -87,7 +84,7 @@ Scrape a URL and return data in specified formats.
8784

8885
---
8986

90-
## CrawlWebsite
87+
## Web.CrawlWebsite
9188

9289
<br />
9390
<TabbedCodeBlock
@@ -128,7 +125,7 @@ Crawl a website and return crawl status and data.
128125

129126
---
130127

131-
## GetCrawlStatus
128+
## Web.GetCrawlStatus
132129

133130
<br />
134131
<TabbedCodeBlock
@@ -160,7 +157,7 @@ Retrieve the status of a crawl job.
160157

161158
---
162159

163-
## GetCrawlData
160+
## Web.GetCrawlData
164161

165162
<br />
166163
<TabbedCodeBlock
@@ -192,7 +189,7 @@ Retrieve data from a completed crawl job.
192189

193190
---
194191

195-
## CancelCrawl
192+
## Web.CancelCrawl
196193

197194
<br />
198195
<TabbedCodeBlock
@@ -224,7 +221,7 @@ Cancel an ongoing crawl job.
224221

225222
---
226223

227-
## MapWebsite
224+
## Web.MapWebsite
228225

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

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

269-
<ToolFooter pipPackageName="arcade_web" />
266+
<ToolFooter pipPackageName="arcade_web" />

0 commit comments

Comments
 (0)