Skip to content

Commit 192e65a

Browse files
authored
fix(docs): align navigation and collapse integration fields (#9732)
* fix(docs): align navigation and collapse integration fields * fix(docs): cover ToC hover color and underline invariants
1 parent eb4eb57 commit 192e65a

98 files changed

Lines changed: 1337 additions & 143 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎apps/docs/EDITORIAL_GUIDE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ A link replaces repeated detail only after the owner contains it. Keep a concise
6060
- Use a callout for a specific prerequisite or a non-obvious security, data-loss, or operational risk that deserves interruption. Use ordinary prose or a table for normal explanation. Keep important limits visible.
6161
- Use Markdown lists and tables for simple procedures and reference data. Use tabs for distinct configurations and Steps for substantial sequential procedures.
6262
- Integration table cells use ordinary word wrapping so short field names and types stay readable. Keep long tokens within the existing table scroll container; do not let them widen the page.
63-
- On large integration references, keep action and trigger descriptions visible and fold their field tables into `ReferenceDetails`. Preserve headings inside each disclosure so direct links and browser search can reveal them. Setup requirements and consequential warnings stay outside the folded tables.
63+
- On integration references, keep action and trigger descriptions visible and fold their field tables into `ReferenceDetails`, regardless of the number of fields. Preserve headings inside each disclosure so direct links and browser search can reveal them. Setup requirements and consequential warnings stay outside the folded tables.
6464
- Integration logos belong beside the page title, using the generated `integration` frontmatter. Keep the regular docs header actions and do not repeat the logo in the article body.
6565
- Match inline code to Sim Chat: normal-weight monospace text, tight padding, and the existing borderless filled surface tokens. Scope the treatment to prose code; preserve fenced examples, API route bars, schema controls, and selector labels.
6666
- Use the shared `TabsSelect` control for API response and request-example pickers, with accessible names that include the current value, checked radio semantics for single choices, and menus aligned to their triggers. Keep docs pickers nonmodal so they do not hide lazily hydrating siblings. Keep response headings free of inherited extra margins. Scope dependency filter styling to `data-object-search-input`, including schema popovers portaled to the body; focus stays inside the field, and touch fields retain the shared target and text sizes.

‎apps/docs/components/docs/navigation.tsx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ interface NavigationItemProps extends Omit<SidebarNavigationProps, 'nodes'> {
1717
}
1818

1919
const rowClass =
20-
'group flex min-h-[30px] w-full items-center gap-1.5 rounded-lg px-2 py-[5px] text-docs-nav text-[var(--docs-text)] transition-colors focus-visible:outline-2 focus-visible:outline-[var(--docs-link)] focus-visible:outline-offset-2'
20+
'group flex min-h-[30px] w-full items-center gap-1.5 rounded-lg px-2 py-[5px] text-left text-docs-nav text-[var(--docs-text)] transition-colors focus-visible:outline-2 focus-visible:outline-[var(--docs-link)] focus-visible:outline-offset-2'
2121

2222
function containsPath(node: NavNode, pathname: string): boolean {
2323
return (

‎apps/docs/components/docs/table-of-contents.tsx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ export function TableOfContents({ headings, active, compact = false }: TableOfCo
2626
if (details) details.open = false
2727
}}
2828
className={cn(
29-
'dark:-mx-2 block rounded-md pointer-coarse:py-3 text-docs-control leading-5 transition-colors focus-visible:outline-2 focus-visible:outline-[var(--docs-link)] focus-visible:outline-offset-2 dark:px-2 dark:hover:bg-[var(--docs-hover)]',
29+
'dark:-mx-2 block rounded-md pointer-coarse:py-3 text-docs-control leading-5 transition-colors focus-visible:outline-2 focus-visible:outline-[var(--docs-link)] focus-visible:outline-offset-2 dark:px-2',
3030
depth > 2 && 'pl-3 dark:pl-5',
3131
active === id
32-
? 'text-[var(--docs-toc-current)] dark:underline dark:underline-offset-[3px]'
33-
: 'text-[var(--docs-muted)] hover:text-[var(--docs-heading)] dark:hover:text-[var(--docs-muted)]'
32+
? 'text-[var(--docs-toc-current)] underline underline-offset-[3px]'
33+
: 'text-[var(--docs-muted)]'
3434
)}
3535
>
3636
{title}

‎apps/docs/content/docs/integrations/apify.mdx‎

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,13 @@ integration:
66
color: "#FFFFFF"
77
---
88

9+
import { ReferenceDetails } from "@/components/ui/reference-details"
10+
911

1012
{/* MANUAL-CONTENT-START:intro */}
1113
[Apify](https://apify.com/) runs Actors for web scraping and browser automation. Run an Actor synchronously when it can finish within the synchronous endpoint’s five-minute limit. **Run Actor (Async)** starts a provider run and polls it within the same Sim step; it does not return immediately for detached processing. Its polling budget follows Sim’s default synchronous execution timeout. If that wait ends before the Actor finishes, use the returned run ID with **Get Run**, then retrieve dataset items after success. You can also run saved Actor tasks and fetch dataset items directly.
1214
{/* MANUAL-CONTENT-END */}
1315

14-
1516
## Use the block [#usage-instructions]
1617

1718
Run any Apify actor or saved task with custom input, fetch dataset items, and check run status. Supports both synchronous and asynchronous execution with automatic dataset fetching.
@@ -22,6 +23,8 @@ Run any Apify actor or saved task with custom input, fetch dataset items, and ch
2223

2324
Run an APIFY actor synchronously and get results (max 5 minutes)
2425

26+
<ReferenceDetails>
27+
2528
#### Input
2629

2730
| Parameter | Type | Required | Description |
@@ -42,10 +45,14 @@ Run an APIFY actor synchronously and get results (max 5 minutes)
4245
| `status` | string | Run status \(SUCCEEDED, FAILED, etc.\) |
4346
| `items` | array | Dataset items \(if completed\) |
4447

48+
</ReferenceDetails>
49+
4550
### APIFY Run Actor (Async)
4651

4752
Start an APIFY Actor run and poll it within the same workflow step until completion or the polling deadline
4853

54+
<ReferenceDetails>
55+
4956
#### Input
5057

5158
| Parameter | Type | Required | Description |
@@ -69,10 +76,14 @@ Start an APIFY Actor run and poll it within the same workflow step until complet
6976
| `datasetId` | string | Dataset ID containing results |
7077
| `items` | array | Dataset items \(if completed\) |
7178

79+
</ReferenceDetails>
80+
7281
### APIFY Run Task
7382

7483
Run a saved APIFY actor task synchronously and get dataset items (max 5 minutes)
7584

85+
<ReferenceDetails>
86+
7687
#### Input
7788

7889
| Parameter | Type | Required | Description |
@@ -93,10 +104,14 @@ Run a saved APIFY actor task synchronously and get dataset items (max 5 minutes)
93104
| `status` | string | Run status \(SUCCEEDED, FAILED, etc.\) |
94105
| `items` | array | Dataset items produced by the run |
95106

107+
</ReferenceDetails>
108+
96109
### APIFY Get Dataset Items
97110

98111
Retrieve items stored in an APIFY dataset
99112

113+
<ReferenceDetails>
114+
100115
#### Input
101116

102117
| Parameter | Type | Required | Description |
@@ -116,10 +131,14 @@ Retrieve items stored in an APIFY dataset
116131
| `items` | array | Items stored in the dataset |
117132
| `count` | number | Number of items returned |
118133

134+
</ReferenceDetails>
135+
119136
### APIFY Get Run
120137

121138
Get the status and details of an APIFY actor run
122139

140+
<ReferenceDetails>
141+
123142
#### Input
124143

125144
| Parameter | Type | Required | Description |
@@ -140,4 +159,6 @@ Get the status and details of an APIFY actor run
140159
| `keyValueStoreId` | string | Default key-value store ID for the run |
141160
| `stats` | json | Run statistics \(memory, CPU, duration\) |
142161

162+
</ReferenceDetails>
163+
143164

‎apps/docs/content/docs/integrations/arxiv.mdx‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,13 @@ integration:
66
color: "#FFFFFF"
77
---
88

9+
import { ReferenceDetails } from "@/components/ui/reference-details"
10+
911

1012
{/* MANUAL-CONTENT-START:intro */}
1113
[arXiv](https://arxiv.org/) hosts research papers. Search by keyword, author, title, or category, retrieve a paper’s metadata, or list papers by an author. This integration does not require an API key or OAuth connection.
1214
{/* MANUAL-CONTENT-END */}
1315

14-
1516
## Use the block [#usage-instructions]
1617

1718
Search arXiv papers, retrieve paper metadata, or list an author’s papers. No API key or OAuth connection is required.
@@ -22,6 +23,8 @@ Search arXiv papers, retrieve paper metadata, or list an author’s papers. No A
2223

2324
Search for academic papers on ArXiv by keywords, authors, titles, or other fields.
2425

26+
<ReferenceDetails>
27+
2528
#### Input
2629

2730
| Parameter | Type | Required | Description |
@@ -39,10 +42,14 @@ Search for academic papers on ArXiv by keywords, authors, titles, or other field
3942
| `papers` | json | Array of papers matching the search query |
4043
| `totalResults` | number | Total number of results found for the search query |
4144

45+
</ReferenceDetails>
46+
4247
### ArXiv Get Paper
4348

4449
Get detailed information about a specific ArXiv paper by its ID.
4550

51+
<ReferenceDetails>
52+
4653
#### Input
4754

4855
| Parameter | Type | Required | Description |
@@ -55,10 +62,14 @@ Get detailed information about a specific ArXiv paper by its ID.
5562
| --------- | ---- | ----------- |
5663
| `paper` | json | Detailed information about the requested ArXiv paper |
5764

65+
</ReferenceDetails>
66+
5867
### ArXiv Get Author Papers
5968

6069
Search for papers by a specific author on ArXiv.
6170

71+
<ReferenceDetails>
72+
6273
#### Input
6374

6475
| Parameter | Type | Required | Description |
@@ -73,4 +84,6 @@ Search for papers by a specific author on ArXiv.
7384
| `authorPapers` | json | Array of papers authored by the specified author |
7485
| `totalResults` | number | Total number of papers found for the author |
7586

87+
</ReferenceDetails>
88+
7689

‎apps/docs/content/docs/integrations/azure_devops.mdx‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -616,6 +616,8 @@ A trigger starts a workflow when a supported event occurs in this service.
616616

617617
Trigger workflow when an Azure DevOps build fails, is canceled, or partially succeeds
618618

619+
<ReferenceDetails label="Configuration and outputs">
620+
619621
#### Output
620622

621623
| Parameter | Type | Description |
@@ -634,13 +636,14 @@ Trigger workflow when an Azure DevOps build fails, is canceled, or partially suc
634636
| `finishTime` | string | Build finish time \(ISO 8601\) |
635637
| `buildUrl` | string | API URL for the build resource |
636638

637-
638-
---
639+
</ReferenceDetails>
639640

640641
### Azure DevOps Webhook (All Service Hook Events)
641642

642643
Trigger on whichever service hook event types you configure in Azure DevOps. Sim does not filter deliveries for this trigger.
643644

645+
<ReferenceDetails label="Configuration and outputs">
646+
644647
#### Output
645648

646649
| Parameter | Type | Description |
@@ -655,13 +658,14 @@ Trigger on whichever service hook event types you configure in Azure DevOps. Sim
655658
| `message` | json | Short message object |
656659
| `detailedMessage` | json | Detailed message object |
657660

658-
659-
---
661+
</ReferenceDetails>
660662

661663
### Azure DevOps Work Item Created
662664

663665
Trigger workflow when a work item is created in Azure DevOps
664666

667+
<ReferenceDetails label="Configuration and outputs">
668+
665669
#### Output
666670

667671
| Parameter | Type | Description |
@@ -679,3 +683,5 @@ Trigger workflow when a work item is created in Azure DevOps
679683
| `projectName` | string | Azure DevOps project name |
680684
| `workItemUrl` | string | API URL for the work item resource |
681685

686+
</ReferenceDetails>
687+

‎apps/docs/content/docs/integrations/brandfetch.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,8 @@ Retrieve brand assets including logos, colors, fonts, and company info by domain
6767

6868
Search for brands by name and find their domains and logos
6969

70+
<ReferenceDetails>
71+
7072
#### Input
7173

7274
| Parameter | Type | Required | Description |
@@ -85,4 +87,6 @@ Search for brands by name and find their domains and logos
8587
| ↳ `claimed` | boolean | Whether the brand profile is claimed |
8688
| ↳ `icon` | string | Brand icon URL |
8789

90+
</ReferenceDetails>
91+
8892

‎apps/docs/content/docs/integrations/calendly.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -935,6 +935,8 @@ Trigger workflow when someone submits a Calendly routing form
935935

936936
Trigger workflow from any Calendly webhook event
937937

938+
<ReferenceDetails label="Configuration and outputs">
939+
938940
#### Configuration
939941

940942
| Parameter | Type | Required | Description |
@@ -951,3 +953,5 @@ Trigger workflow from any Calendly webhook event
951953
| `created_by` | string | URI of the Calendly user who created this webhook |
952954
| `payload` | object | Complete event payload \(structure varies by event type\) |
953955

956+
</ReferenceDetails>
957+

‎apps/docs/content/docs/integrations/clay.mdx‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,13 @@ integration:
66
color: "#FFFFFF"
77
---
88

9+
import { ReferenceDetails } from "@/components/ui/reference-details"
10+
911

1012
{/* MANUAL-CONTENT-START:intro */}
1113
[Clay](https://www.clay.com/) organizes and enriches data in tables. Use the Clay Populate action to send structured data from your Sim workflow to a Clay table through its webhook URL—for example, lead records or research results.
1214
{/* MANUAL-CONTENT-END */}
1315

14-
1516
## Use the block [#usage-instructions]
1617

1718
Send structured records to a Clay table through its webhook URL.
@@ -22,6 +23,8 @@ Send structured records to a Clay table through its webhook URL.
2223

2324
Send structured JSON data to a Clay table webhook and return its response and HTTP metadata.
2425

26+
<ReferenceDetails>
27+
2528
#### Input
2629

2730
| Parameter | Type | Required | Description |
@@ -42,4 +45,6 @@ Send structured JSON data to a Clay table webhook and return its response and HT
4245
| ↳ `timestamp` | string | ISO timestamp recorded when the webhook response was processed |
4346
| ↳ `contentType` | string | Content type of the response |
4447

48+
</ReferenceDetails>
49+
4550

‎apps/docs/content/docs/integrations/datagma.mdx‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ Integrate Datagma to find verified work emails from a name and company, enrich p
2525

2626
Find a verified work email from a person's full name and company. Uses 1 credit when a verified email is found.
2727

28+
<ReferenceDetails>
29+
2830
#### Input
2931

3032
| Parameter | Type | Required | Description |
@@ -47,6 +49,8 @@ Find a verified work email from a person's full name and company. Uses 1 credit
4749
| `smtpCheck` | boolean | Whether SMTP validation succeeded |
4850
| `catchAll` | boolean | Whether the domain is catch-all |
4951

52+
</ReferenceDetails>
53+
5054
### Datagma Enrich Person
5155

5256
Enrich a person's profile using their email, LinkedIn URL, or full name and company. Returns job title, company, location, and social data. Uses 2 credits per match; add 30 credits when a phone number is found.
@@ -92,6 +96,8 @@ Enrich a person's profile using their email, LinkedIn URL, or full name and comp
9296

9397
Enrich a company profile using a domain, company name, or SIREN number (France). Returns size, industry, revenue, and description. Uses 2 credits per match.
9498

99+
<ReferenceDetails>
100+
95101
#### Input
96102

97103
| Parameter | Type | Required | Description |
@@ -115,10 +121,14 @@ Enrich a company profile using a domain, company name, or SIREN number (France).
115121
| `revenueRange` | string | Estimated annual revenue range |
116122
| `headquarters` | string | Headquarters location |
117123

124+
</ReferenceDetails>
125+
118126
### Datagma Find Phone
119127

120128
Find a mobile phone number from a person's LinkedIn URL. Optionally supply an email to improve match accuracy. Uses 30 credits when a number is found.
121129

130+
<ReferenceDetails>
131+
122132
#### Input
123133

124134
| Parameter | Type | Required | Description |
@@ -136,10 +146,14 @@ Find a mobile phone number from a person's LinkedIn URL. Optionally supply an em
136146
| `countryCode` | string | Country code prefix \(e.g., +1\) |
137147
| `isWhatsapp` | boolean | Whether the number is linked to WhatsApp |
138148

149+
</ReferenceDetails>
150+
139151
### Datagma Get Credits
140152

141153
Check remaining credit balance on a Datagma account. Free — no credits consumed.
142154

155+
<ReferenceDetails>
156+
143157
#### Input
144158

145159
| Parameter | Type | Required | Description |
@@ -152,4 +166,6 @@ Check remaining credit balance on a Datagma account. Free — no credits consume
152166
| --------- | ---- | ----------- |
153167
| `credits` | number | Remaining Datagma credits |
154168

169+
</ReferenceDetails>
170+
155171

0 commit comments

Comments
 (0)