Skip to content

Commit f132b18

Browse files
ianmacartneyConvex, Inc.
authored andcommitted
Ian/restore component lists (#43592)
- adds links to components to the docs in more contextual places GitOrigin-RevId: 164d7eaf45e0335903fcbebb33e464ba3f9357ac
1 parent 48ad83e commit f132b18

File tree

5 files changed

+118
-48
lines changed

5 files changed

+118
-48
lines changed

npm-packages/docs/docs/error.mdx

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
description: "Understand specific errors thrown by Convex"
33
---
44

5+
import { ComponentCardList } from "@site/src/components/ComponentCard";
6+
57
# Errors and Warnings
68

79
This page explains specific errors thrown by Convex.
@@ -98,3 +100,28 @@ To fix this issue:
98100
- Learn more about [optimistic concurrency control](/database/advanced/occ.md).
99101
- See this [Stack post](https://stack.convex.dev/waitlist) for an example of
100102
designing an app to avoid mutation conflicts.
103+
104+
### Related Components
105+
106+
<ComponentCardList
107+
items={[
108+
{
109+
title: "Workpool",
110+
description:
111+
"Workpool give critical tasks priority by organizing async operations into separate, customizable queues.",
112+
href: "https://www.convex.dev/components/workpool",
113+
},
114+
{
115+
title: "Sharded Counter",
116+
description:
117+
"High-throughput counter enables denormalized counts without write conflicts by spreading writes over multiple documents.",
118+
href: "https://www.convex.dev/components/sharded-counter",
119+
},
120+
{
121+
title: "Action Cache",
122+
description:
123+
"Cache frequently run actions. By leveraging the `force` parameter to keep the cache populated, you can ensure that the cache is always up to date and avoid data races.",
124+
href: "https://www.convex.dev/components/action-cache",
125+
},
126+
]}
127+
/>

npm-packages/docs/docs/functions/actions.mdx

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ sidebar_position: 30
44
description: "Call third-party services and external APIs from Convex"
55
---
66

7+
import { ComponentCardList } from "@site/src/components/ComponentCard";
78
import Constructor from "!!raw-loader!@site/../private-demos/snippets/convex/actionsConstructor.ts";
89
import ArgsWithValidation from "!!raw-loader!@site/../private-demos/snippets/convex/actionsArgsWithValidation.ts";
910
import Context from "!!raw-loader!@site/../private-demos/snippets/convex/actionsContext.ts";
@@ -305,3 +306,28 @@ database access.
305306
Caveats: Separate runQuery / runMutation calls are valid when intentionally
306307
trying to process more data than fits in a single transaction (e.g. running a
307308
migration, doing a live aggregate).
309+
310+
## Related Components
311+
312+
<ComponentCardList
313+
items={[
314+
{
315+
title: "Action Cache",
316+
description:
317+
"Cache expensive or frequently run actions. Allows configurable cache duration and forcing updates.",
318+
href: "https://www.convex.dev/components/action-cache",
319+
},
320+
{
321+
title: "Workpool",
322+
description:
323+
"Workpool give critical tasks priority by organizing async operations into separate, customizable queues. Supports retries and parallelism limits.",
324+
href: "https://www.convex.dev/components/workpool",
325+
},
326+
{
327+
title: "Workflow",
328+
description:
329+
"Similar to Actions, Workflows can call queries, mutations, and actions. However, they are durable functions that can suspend, survive server crashes, specify retries for action calls, and more.",
330+
href: "https://www.convex.dev/components/workflow",
331+
},
332+
]}
333+
/>

npm-packages/docs/docs/functions/error-handling/error-handling.mdx

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ sidebar_position: 70
44
description: "Handle errors in Convex queries, mutations, and actions"
55
---
66

7+
import { ComponentCardList } from "@site/src/components/ComponentCard";
8+
79
There are four reasons why your Convex [queries](/functions/query-functions.mdx)
810
and [mutations](/functions/mutation-functions.mdx) may hit errors:
911

@@ -187,3 +189,22 @@ For information on other limits, see [here](/production/state/limits.mdx).
187189

188190
See [Debugging](/functions/debugging.mdx) and specifically
189191
[Finding relevant logs by Request ID](/functions/debugging.mdx#finding-relevant-logs-by-request-id).
192+
193+
## Related Components
194+
195+
<ComponentCardList
196+
items={[
197+
{
198+
title: "Workpool",
199+
description:
200+
"Workpool give critical tasks priority by organizing async operations into separate, customizable queues. Supports retries and parallelism limits.",
201+
href: "https://www.convex.dev/components/workpool",
202+
},
203+
{
204+
title: "Workflow",
205+
description:
206+
"Simplify programming long running code flows. Workflows execute durably with configurable retries and delays.",
207+
href: "https://www.convex.dev/components/workflow",
208+
},
209+
]}
210+
/>

npm-packages/docs/docs/production/integrations/integrations.mdx

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ description: "Integrate Convex with third party services"
44
sidebar_position: 1
55
---
66

7+
import { ComponentCardList } from "@site/src/components/ComponentCard";
8+
79
Convex integrates with a variety of supported third party tools for log
810
streaming and exception reporting.
911

@@ -35,3 +37,45 @@ integration will stop running within a few seconds.
3537

3638
Please reach out with any questions, comments, or suggestions
3739
[on Discord](https://convex.dev/community).
40+
41+
## Integration Components
42+
43+
Beyond integrations for logs and exceptions, [Convex Components](/components)
44+
make it easier to work with third party services. See the full list of
45+
components on the [Convex Components Directory](https://convex.dev/components).
46+
47+
<ComponentCardList
48+
items={[
49+
{
50+
title: "Cloudflare R2",
51+
description: "Store and serve files in Cloudflare's R2 storage.",
52+
href: "https://www.convex.dev/components/cloudflare-r2",
53+
},
54+
{
55+
title: "Collaborative Text Editor",
56+
description:
57+
"Real-time collaborative text editing using BlockNote or Tiptap.",
58+
href: "https://www.convex.dev/components/prosemirror-sync",
59+
},
60+
{
61+
title: "Expo Push Notifications",
62+
description: "Send mobile push notifications using Expo.",
63+
href: "https://www.convex.dev/components/push-notifications",
64+
},
65+
{
66+
title: "Twilio SMS",
67+
description: "Send and receive SMS messages using Twilio's API.",
68+
href: "https://www.convex.dev/components/twilio",
69+
},
70+
{
71+
title: "LaunchDarkly Feature Flags",
72+
description: "Sync feature flags with backend, backed by LaunchDarkly.",
73+
href: "https://www.convex.dev/components/launchdarkly",
74+
},
75+
{
76+
title: "Polar",
77+
description: "Add subscriptions and billing with Polar.",
78+
href: "https://www.convex.dev/components/polar",
79+
},
80+
]}
81+
/>

npm-packages/docs/src/ComponentCardList.tsx

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

0 commit comments

Comments
 (0)