Skip to content

Commit 8624add

Browse files
authored
Merge pull request #703 from pipecat-ai/mb/docs-reorg
Docs reorg
2 parents dbff7ab + bb0c4be commit 8624add

289 files changed

Lines changed: 2722 additions & 2781 deletions

File tree

Some content is hidden

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

cli/cloud/agent.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,15 @@ pipecat cloud agent start [ARGS] [OPTIONS]
3131
Public API key to authenticate the agent deployment. Will default to any key
3232
set in your config.
3333

34-
For more information, see [API keys](/deployment/pipecat-cloud/fundamentals/accounts-and-organizations#api-keys).
34+
For more information, see [API keys](/pipecat-cloud/fundamentals/accounts-and-organizations#api-keys).
3535

3636
</ParamField>
3737

3838
<ParamField path="--data / -d" type="string">
3939
Stringified JSON object to pass to the agent deployment. This data will be
4040
available to the agent as a `data` parameter in your `bot()` method.
4141

42-
More information [here](/deployment/pipecat-cloud/fundamentals/active-sessions#running-an-agent).
42+
More information [here](/pipecat-cloud/fundamentals/active-sessions#running-an-agent).
4343

4444
</ParamField>
4545

cli/cloud/auth.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ pipecat cloud auth logout
4747

4848
## use-pat
4949

50-
Authenticates with a [Personal Access Token](/deployment/pipecat-cloud/guides/personal-access-tokens) instead of interactive OAuth login. Validates the token against the API and stores it in your local config file.
50+
Authenticates with a [Personal Access Token](/pipecat-cloud/guides/personal-access-tokens) instead of interactive OAuth login. Validates the token against the API and stores it in your local config file.
5151

5252
**Usage:**
5353

@@ -63,7 +63,7 @@ pipecat cloud auth use-pat <token>
6363

6464
<Tip>
6565
You can also set the `PIPECAT_TOKEN` environment variable instead of storing
66-
the token locally. See the [PAT guide](/deployment/pipecat-cloud/guides/personal-access-tokens)
66+
the token locally. See the [PAT guide](/pipecat-cloud/guides/personal-access-tokens)
6767
for details.
6868
</Tip>
6969

@@ -111,7 +111,7 @@ pipecat cloud --show-cli-config
111111
<Card
112112
title="More about user accounts"
113113
icon="people-group"
114-
href="/deployment/pipecat-cloud/fundamentals/accounts-and-organizations"
114+
href="/pipecat-cloud/fundamentals/accounts-and-organizations"
115115
>
116116
Managing your account and collaborating on agents as part of a team
117117
</Card>

cli/cloud/deploy.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ description: "Create or modify an agent deployment"
55

66
The `deploy` command creates a new agent deployment or updates an existing one. It builds a deployment manifest with the provided parameters and monitors the deployment status until the agent is ready.
77

8-
When no image is specified, the CLI will offer to build your agent using [Pipecat Cloud Build](/deployment/pipecat-cloud/guides/cloud-builds). This handles building and deploying without requiring you to manage a container registry. A `Dockerfile` must be present in your build context directory.
8+
When no image is specified, the CLI will offer to build your agent using [Pipecat Cloud Build](/pipecat-cloud/guides/cloud-builds). This handles building and deploying without requiring you to manage a container registry. A `Dockerfile` must be present in your build context directory.
99

1010
If the agent name already exists, you'll be prompted to confirm the update unless the `--force` flag is used.
1111

12-
This command will wait for the active deployment / revision to enter a ready state before returning. If the deployment fails, the command will exit with an [error](/deployment/pipecat-cloud/fundamentals/error-codes) with more information.
12+
This command will wait for the active deployment / revision to enter a ready state before returning. If the deployment fails, the command will exit with an [error](/pipecat-cloud/fundamentals/error-codes) with more information.
1313

1414
## Usage
1515

@@ -26,7 +26,7 @@ pipecat cloud deploy [ARGS] [OPTIONS]
2626
<ParamField path="image" type="string">
2727
URL of the Docker image to deploy. Must be a valid Docker image URL. For
2828
example: `docker.io/my-repo/my-image:latest`. Not required when using [cloud
29-
builds](/deployment/pipecat-cloud/guides/cloud-builds) or `--build-id`.
29+
builds](/pipecat-cloud/guides/cloud-builds) or `--build-id`.
3030
</ParamField>
3131

3232
**Options:**
@@ -80,7 +80,7 @@ In addition to this flag, you also need to enable the `KrispVivaFilter()` for yo
8080
The agent profile to use for resource allocation. Valid values are:
8181
`agent-1x`, `agent-2x`, `agent-3x`.
8282

83-
See [Agent Profiles](/deployment/pipecat-cloud/fundamentals/deploy#agent-profiles) for more information.
83+
See [Agent Profiles](/pipecat-cloud/fundamentals/deploy#agent-profiles) for more information.
8484

8585
</ParamField>
8686

cli/cloud/organizations.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ pipecat cloud organizations default-region eu-central
232232
<Card
233233
title="More about organizations"
234234
icon="people-group"
235-
href="/deployment/pipecat-cloud/fundamentals/accounts-and-organizations"
235+
href="/pipecat-cloud/fundamentals/accounts-and-organizations"
236236
>
237237
Managing your account and collaborating on agents as part of a team
238238
</Card>

cli/cloud/secrets.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ pipecat cloud secrets set [ARGS] [OPTIONS]
5959
<ParamField path="secrets" type="string">
6060
List of secret key-value pairs e.g. `KEY1=value1 KEY2="value with spaces"`.
6161

62-
See [this note](/deployment/pipecat-cloud/fundamentals/secrets#special-characters) on using special
62+
See [this note](/pipecat-cloud/fundamentals/secrets#special-characters) on using special
6363
characters in secret values.
6464

6565
Example:
@@ -238,7 +238,7 @@ pipecat cloud secrets image-pull-secret my-registry-creds https://index.docker.i
238238
<Card
239239
title="More about secrets"
240240
icon="key"
241-
href="/deployment/pipecat-cloud/fundamentals/secrets"
241+
href="/pipecat-cloud/fundamentals/secrets"
242242
>
243243
Learn more about managing application secrets
244244
</Card>

client/android/introduction.mdx

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,15 +48,14 @@ client.startBotAndConnect(startBotParams).withCallback {
4848
## Documentation
4949

5050
<CardGroup cols={2}>
51+
<Card title="API Reference" icon="book" href="/client/android/api-reference">
52+
SDK API documentation
53+
</Card>
5154
<Card
52-
title="API Reference"
53-
icon="book"
54-
href="https://docs-android.rtvi.ai/"
55+
title="Transport Packages"
56+
icon="network-wired"
57+
href="/client/android/transports/daily"
5558
>
56-
Complete SDK API documentation
57-
</Card>
58-
59-
<Card title="Daily Transport" icon="network-wired" href="./transports/daily">
60-
WebRTC implementation using Daily
59+
Daily, Gemini, OpenAI WebRTC, and SmallWebRTC transports
6160
</Card>
6261
</CardGroup>

client/android/migration-guide.mdx

Lines changed: 0 additions & 153 deletions
This file was deleted.

client/c++/api-reference.mdx

Lines changed: 0 additions & 4 deletions
This file was deleted.

client/ios/introduction.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -62,28 +62,28 @@ self.pipecatClientIOS?.startBotAndConnect(startBotParams: startBotParams) { (res
6262
## Documentation
6363

6464
<CardGroup cols={2}>
65-
<Card title="API Reference" icon="book" href="https://docs-ios.pipecat.ai/">
66-
Complete SDK API documentation
65+
<Card title="API Reference" icon="book" href="/client/ios/api-reference">
66+
SDK API documentation
67+
</Card>
68+
<Card
69+
title="Transport Packages"
70+
icon="network-wired"
71+
href="/client/ios/transports/daily"
72+
>
73+
Daily, Gemini, OpenAI WebRTC, and SmallWebRTC transports
6774
</Card>
6875
<Card
69-
horizontal
7076
title="Source"
7177
icon="github"
7278
href="https://github.com/pipecat-ai/pipecat-client-ios/"
7379
>
74-
Pipecat Client iOS
80+
Pipecat Client iOS on GitHub
7581
</Card>
76-
</CardGroup>
77-
<CardGroup cols={2}>
7882
<Card
79-
horizontal
8083
title="Demo"
8184
icon="play"
8285
href="https://github.com/pipecat-ai/pipecat-examples/tree/main/simple-chatbot/client/ios"
8386
>
8487
Simple Chatbot Demo
8588
</Card>
86-
<Card title="Daily Transport" icon="network-wired" href="./transports/daily">
87-
WebRTC implementation using Daily
88-
</Card>
8989
</CardGroup>

0 commit comments

Comments
 (0)