Skip to content

Commit 4c065e3

Browse files
committed
Fix title capitalizations
1 parent 800886c commit 4c065e3

File tree

4 files changed

+39
-39
lines changed

4 files changed

+39
-39
lines changed

docs-v2/pages/connect/_meta.tsx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,40 +3,40 @@ export default {
33
"title": "Overview",
44
},
55
"use-cases": {
6-
"title": "Use Cases",
6+
"title": "Use cases",
77
},
88
"quickstart": {
99
"title": "Quickstart",
1010
},
1111
"workflows": {
12-
"title": "Running Workflows",
12+
"title": "Running workflows",
1313
},
1414
"components": {
15-
"title": "Running Components",
15+
"title": "Running components",
1616
},
1717
"api": {
18-
"title": "API & SDK Reference",
18+
"title": "API & SDK reference",
1919
},
2020
"tokens": {
21-
"title": "Connect Tokens",
21+
"title": "Connect tokens",
2222
},
2323
"environments": {
2424
"title": "Environments",
2525
},
2626
"oauth-clients": {
27-
"title": "OAuth Clients",
27+
"title": "OAuth clients",
2828
},
2929
"webhooks": {
3030
"title": "Webhooks",
3131
},
3232
"connect-link": {
33-
"title": "Connect Link",
33+
"title": "Connect link",
3434
},
3535
"troubleshooting": {
3636
"title": "Troubleshooting",
3737
},
3838
"customize-your-app": {
39-
"title": "Customize Your App",
39+
"title": "Customize your app",
4040
},
4141
"migrating-from-project-keys-to-oauth": {
4242
"display": "hidden",

docs-v2/pages/connect/api.mdx

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
import Callout from '@/components/Callout'
22
import { Tabs } from 'nextra/components'
33

4-
# Connect API & SDK Reference
4+
# Connect API & SDK reference
55

66
Pipedream provides a TypeScript SDK and a REST API to interact with the Connect service. You'll find examples using the SDK and the REST API in multiple languages below.
77

8-
## REST API Base URL
8+
## REST API base URL
99

1010
Pipedream Connect resources are scoped to [projects](/projects), so you'll need to pass [the project's ID](/projects#finding-your-projects-id) as a part of the base URL:
1111

@@ -43,7 +43,7 @@ or a specific version:
4343

4444
See the [REST API Authentication docs](/rest-api/auth).
4545

46-
### TypeScript SDK (Server)
46+
### TypeScript SDK (server)
4747

4848
Most of your interactions with the Connect API will happen on the server, to protect API requests and user credentials. You'll use the SDK in [your frontend](#typescript-sdk-browser) to let users connect accounts. Once connected, you'll use the SDK on the server to retrieve credentials, invoke workflows on their behalf, and more.
4949

@@ -63,7 +63,7 @@ const pd = createBackendClient({
6363
// The `pd` client provides methods to interact with the Connect API — see below
6464
```
6565

66-
### TypeScript SDK (Browser)
66+
### TypeScript SDK (browser)
6767

6868
You'll primarily use the browser SDK to let your users securely connect apps from your frontend. Here, you
6969

@@ -667,7 +667,7 @@ curl -X GET \
667667
}
668668
```
669669

670-
##### Example Response (with `include_credentials=true`)
670+
##### Example response (with `include_credentials=true`)
671671

672672
```json
673673
{
@@ -954,7 +954,7 @@ Pipedream returns a `204 No Content` response on successful account deletion
954954

955955
### Components
956956

957-
#### List Components
957+
#### List components
958958

959959
List all the components in the Pipedream registry.
960960

@@ -1060,8 +1060,8 @@ curl -X GET "https://api.pipedream.com/v1/connect/{your_project_id}/components?a
10601060
</Tabs.Tab>
10611061
</Tabs>
10621062

1063-
##### Example Response
10641063

1064+
##### Example response
10651065
```json
10661066
{
10671067
"page_info": {
@@ -1091,7 +1091,7 @@ curl -X GET "https://api.pipedream.com/v1/connect/{your_project_id}/components?a
10911091
```
10921092

10931093

1094-
#### Retrieve a Component
1094+
#### Retrieve a component
10951095

10961096
Retrieve a specific component from the Pipedream registry.
10971097

@@ -1181,7 +1181,7 @@ curl -X GET "https://api.pipedream.com/v1/connect/{your_project_id}/components/g
11811181
</Tabs.Tab>
11821182
</Tabs>
11831183

1184-
##### Example Response
1184+
##### Example response
11851185

11861186
```json
11871187
{
@@ -1219,7 +1219,7 @@ curl -X GET "https://api.pipedream.com/v1/connect/{your_project_id}/components/g
12191219

12201220

12211221

1222-
#### Configure a Component
1222+
#### Configure a component
12231223

12241224
Configure the a component's prop, based on the current component's
12251225
configuration. This endpoint will use the component's configuration to retrieve
@@ -1236,7 +1236,7 @@ GET /{component_type}/configure
12361236

12371237
Either `triggers`, `actions`, or `components`.
12381238

1239-
##### Body Parameters
1239+
##### Body parameters
12401240

12411241
`configured_props` **object**
12421242

@@ -1369,7 +1369,7 @@ curl -X GET "https://api.pipedream.com/v1/connect/{your_project_id}/components/c
13691369

13701370
</Tabs>
13711371

1372-
##### Example Response
1372+
##### Example response
13731373

13741374
```json
13751375
{
@@ -1418,7 +1418,7 @@ curl -X GET "https://api.pipedream.com/v1/connect/{your_project_id}/components/c
14181418
}
14191419
```
14201420

1421-
#### Reload a Component's Props (i.e. Configure Dynamic Props)
1421+
#### Reload a component's props (i.e. configure dynamic props)
14221422

14231423
Reload the component's props after configuring a dynamic prop, based on the
14241424
current component's configuration. This endpoint will use the component's
@@ -1436,7 +1436,7 @@ GET /{component_type}/props
14361436

14371437
Either `triggers`, `actions`, or `components`.
14381438

1439-
##### Body Parameters
1439+
##### Body parameters
14401440

14411441
`configured_props` **object**
14421442

@@ -1580,7 +1580,7 @@ curl -X GET "https://api.pipedream.com/v1/connect/{your_project_id}/components/p
15801580

15811581
</Tabs>
15821582

1583-
##### Example Response
1583+
##### Example response
15841584

15851585
```json
15861586
{
@@ -1638,15 +1638,15 @@ curl -X GET "https://api.pipedream.com/v1/connect/{your_project_id}/components/p
16381638
}
16391639
```
16401640

1641-
#### Invoke an Action
1641+
#### Invoke an action
16421642

16431643
Invoke an action component for a Pipedream Connect user in a project.
16441644

16451645
```text
16461646
POST /actions/run
16471647
```
16481648

1649-
##### Body Parameters
1649+
##### Body parameters
16501650

16511651
`id` **string**
16521652

@@ -1787,7 +1787,7 @@ curl -X GET "https://api.pipedream.com/v1/connect/{your_project_id}/actions/run"
17871787

17881788
</Tabs>
17891789

1790-
##### Example Response
1790+
##### Example response
17911791

17921792
```json
17931793
{
@@ -1817,15 +1817,15 @@ curl -X GET "https://api.pipedream.com/v1/connect/{your_project_id}/actions/run"
18171817
}
18181818
```
18191819

1820-
#### Deploy a Trigger
1820+
#### Deploy a trigger
18211821

18221822
Deploy a trigger component for a Pipedream Connect user in a project.
18231823

18241824
```text
18251825
POST /triggers/deploy
18261826
```
18271827

1828-
##### Body Parameters
1828+
##### Body parameters
18291829

18301830
`id` **string**
18311831

@@ -1976,7 +1976,7 @@ curl -X GET "https://api.pipedream.com/v1/connect/{your_project_id}/triggers/dep
19761976

19771977
</Tabs>
19781978

1979-
##### Example Response
1979+
##### Example response
19801980

19811981
```json
19821982
{

docs-v2/pages/connect/components.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ import ArcadeEmbed from '@/components/ArcadeEmbed'
33
import Callout from '@/components/Callout'
44
import Image from 'next/image'
55

6-
# Running Components for Your End Users
6+
# Running components for your end users
77

88
Pipedream Connect provides you with the ability to pre-configure, deploy and
99
invoke [components](/components) **on behalf of [your end
1010
users](/connect/api#external-users)**.
1111

12-
## What are Components?
12+
## What are components?
1313

1414
In the context of Pipedream Connect, components are self-contained executable
1515
units of code. They are usually provided with some arbitrary input and produce a
@@ -20,9 +20,9 @@ repository](https://github.com/PipedreamHQ/pipedream/tree/master/components).
2020
To learn more about components in detail, please visit our [Components
2121
guide](/components).
2222

23-
## How to Run Components for Your End Users
23+
## How to run components for your end users
2424

25-
### Retrieving a Component's Definition
25+
### Retrieving a component's definition
2626

2727
The first thing to do in order to run a component for your end users is to know
2828
about the component itself. To start with, you need to know the component's
@@ -214,7 +214,7 @@ the prop being configured as the value for the `prop_name` attribute.
214214
}
215215
```
216216

217-
#### Dynamic Props
217+
#### Dynamic props
218218

219219
The set of props that a component can accept might not be static, and can change
220220
depending on the values of prior props. Props that behave this way are called
@@ -333,7 +333,7 @@ All this means is that actions can be invoked manually on demand, while sources
333333
are instead deployed and run automatically when the event they are listening for
334334
occurs.
335335

336-
#### Invoking an Action
336+
#### Invoking an action
337337

338338
At the end of the configuration process for an action, you'll end up with a
339339
payload that you can use to invoke the action. The payload is similar to the one
@@ -401,7 +401,7 @@ above:
401401
}
402402
```
403403

404-
#### Deploying a Source
404+
#### Deploying a source
405405

406406
Because sources are exercised by events that happen on a third-party service,
407407
their semantics are different from actions. Once a source is configured, it must

docs-v2/pages/connect/use-cases.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Pipedream Connect Use Cases
1+
# Pipedream Connect use cases
22

33
Developers use Pipedream Connect to build customer-facing API integrations into their products. It lets you build [in-app messaging](#in-app-messaging), [CRM syncs](#crm-syncs), [AI-driven products](#ai-products), and much more, all in a few minutes.
44

55
## Core value to app developers
66

7-
In 20 years of building software, we've seen a common theme. No matter the product, your customers end up needing to connect your app to third-party APIs.
7+
In 20 years of building software, we've seen a common theme. No matter the product, your customers end up needing to connect your app to third-party APIs.
88

99
You might build real-time notifications with messaging apps, export customer data to databases or spreadsheets, ingest data from CRMs, or connect to any of the thousands of APIs and SaaS services your customers are using. These features are often tied to large contracts and Enterprise customers.
1010

@@ -38,4 +38,4 @@ Sync data between your app and Google Sheets, Airtable, or any spreadsheet. Pipe
3838

3939
### And much more
4040

41-
Building an app with Pipedream and want to be profiled here (anonymously or otherwise)? Email <code>[email protected]</code> to let us know!
41+
Building an app with Pipedream and want to be profiled here (anonymously or otherwise)? Email <code>[email protected]</code> to let us know!

0 commit comments

Comments
 (0)