Skip to content

Commit

Permalink
Update links for Node guide
Browse files Browse the repository at this point in the history
  • Loading branch information
djfarrelly committed Nov 19, 2024
1 parent 6db7202 commit ee1c8a9
Show file tree
Hide file tree
Showing 16 changed files with 32 additions and 363 deletions.
15 changes: 9 additions & 6 deletions components/Nav/Menu.tsx
Original file line number Diff line number Diff line change
@@ -1,23 +1,26 @@
import Link from "next/link";
import { type RemixiconComponentType } from "@remixicon/react";

export type MenuProps = {
title: string;
primaryLinks?: {
title: string;
description: string;
url: string;
icon: React.ComponentType<{ size: number }>;
icon: React.ComponentType<{ size: number }> | RemixiconComponentType;
iconBg: string;
}[];
secondaryTitle?: string;
secondaryLinks?: {
title: string;
url: string;
icon: React.ComponentType<{
size: number;
color?: string;
className?: string;
}>;
icon:
| React.ComponentType<{
size: number;
color?: string;
className?: string;
}>
| RemixiconComponentType;
iconClassName?: string;
}[];
headerUrl?: string;
Expand Down
15 changes: 11 additions & 4 deletions components/Nav/links.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@ import {
IconPower,
IconRetry,
} from "src/shared/Icons/duotone";
import { RiNextjsFill, RiNodejsFill } from "@remixicon/react";
import PythonIcon from "src/shared/Icons/Python";
import TypeScriptIcon from "src/shared/Icons/TypeScript";
// import TypeScriptIcon from "src/shared/Icons/TypeScript";

import { type MenuProps } from "./Menu";

Expand Down Expand Up @@ -108,9 +109,15 @@ export const resourcesLinks: MenuProps = {
secondaryTitle: "Quick start guides",
secondaryLinks: [
{
title: "TypeScript / JavaScript",
url: "/docs/quick-start?ref=nav",
icon: TypeScriptIcon,
title: "Next.js",
url: "/docs/getting-started/nextjs-quick-start?ref=nav",
icon: RiNextjsFill,
iconClassName: "w-4",
},
{
title: "Node.js",
url: "/docs/getting-started/nodejs-quick-start?ref=nav",
icon: RiNodejsFill,
iconClassName: "w-4",
},
{
Expand Down
2 changes: 1 addition & 1 deletion data/uses/serverless-node-background-jobs.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ await inngest.send({
description:
"A step-by-step guide to learn how to build with Inngest in less than 5 minutes.",
type: "Tutorial",
href: "/docs/getting-started/nextjs-quick-start",
href: "/docs/getting-started/nodejs-quick-start",
},
{
title: "Running Background Jobs",
Expand Down
2 changes: 1 addition & 1 deletion pages/blog/_posts/announcing-pcxi-hackathon.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Moreover, here's a list of resources you may find useful:

- [Xata Summer Hackathon resource hub](https://xata.notion.site/Summer-Hackathon-Resources-a612dffc333a41c2bf9f3f8ed7712750)
- [Clerk Hackathon Resources](https://clerkdev.notion.site/Clerk-Hackathon-Resources-1993bf4a3b3841fb91b01b209b9258d1)
- [Inngest Quick Start](/docs/getting-started/nextjs-quick-start)
- [Inngest Quick Start](/docs/getting-started/nextjs-quick-start?ref=blog-pcxi-hackathon)
- Inngest Blog: [AI in production: Managing capacity with flow control](/blog/ai-in-production-managing-capacity-with-flow-control)

## Questions?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ As you might be able to see, there is a ton that you could do from here using al

## How do I get started?

Once you set up the Inngest webhook with Clerk, you can run through [this Inngest quick start](/docs/getting-started/nextjs-quick-start) or check out [example projects](https://github.com/inngest/inngest-js/tree/main/examples) for your framework of choice. If you want to learn more about Inngest webhooks, check out [the guide here](/docs/platform/webhooks).
Once you set up the Inngest webhook with Clerk, you can run through [this Inngest quick start](/docs/getting-started/nextjs-quick-start?ref=blog-clerk-integration) or check out [example projects](https://github.com/inngest/inngest-js/tree/main/examples) for your framework of choice. If you want to learn more about Inngest webhooks, check out [the guide here](/docs/platform/webhooks).


## Onward
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ const generateIdeasFunction = inngest.createFunction(
);
```

For more information on this, check out [our guide on debouncing](/docs/reference/functions/debounce) or check out [our quick start tutorial](/docs/getting-started/nextjs-quick-start) to learn the basics of Inngest.
For more information on this, check out [our guide on debouncing](/docs/reference/functions/debounce) or check out [our quick start tutorial](/docs/getting-started/nextjs-quick-start?ref=blog-debounce-in-queueing-systems) to learn the basics of Inngest.

## Conclusion

Expand Down
2 changes: 1 addition & 1 deletion pages/docs/guides/user-defined-workflows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Our users will be able to combine those tasks to build their custom workflows.

### 1. Adding the tasks definition to the application

After [installing and setup Inngest](/docs/getting-started/nextjs-quick-start) in our Next.js application, we will create the following [Workflow Actions definition](/docs/reference/workflow-kit/actions) file:
After [installing and setup Inngest](/docs/getting-started/nextjs-quick-start?ref=docs-guide-user-defined-workflows) in our Next.js application, we will create the following [Workflow Actions definition](/docs/reference/workflow-kit/actions) file:

```ts {{ title: "lib/inngest/workflowActions.ts" }}
import { type PublicEngineAction } from "@inngest/workflow-kit";
Expand Down
6 changes: 3 additions & 3 deletions pages/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Write functions in TypeScript, Python or Go to power background and scheduled jo
<CardGroup cols={2}>

<Card
href={"/docs/getting-started/nextjs-quick-start"}
href={"/docs/getting-started/nextjs-quick-start?ref=docs-home"}
title={"Next.js"}
icon={<RiNextjsFill className="text-basis h-8 w-8"/>}
iconPlacement="top"
Expand All @@ -34,7 +34,7 @@ Write functions in TypeScript, Python or Go to power background and scheduled jo
</Card>

<Card
href={"/docs/getting-started/nodejs-quick-start"}
href={"/docs/getting-started/nodejs-quick-start?ref=docs-home"}
title={"Node.js"}
icon={<RiNodejsFill className="text-basis h-8 w-8"/>}
iconPlacement="top"
Expand All @@ -43,7 +43,7 @@ Write functions in TypeScript, Python or Go to power background and scheduled jo
</Card>

<Card
href={"/docs/getting-started/python-quick-start"}
href={"/docs/getting-started/python-quick-start?ref=docs-home"}
title={"Python"}
icon={<PythonIcon className="text-basis h-8 w-8"/>}
iconPlacement="top"
Expand Down
4 changes: 2 additions & 2 deletions pages/docs/learn/glossary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ An event is a trigger that initiates the execution of a [function](#inngest-func

## Inngest Function

Inngest functions are the fundamental building blocks of the Inngest platform,
Inngest functions are the fundamental building blocks of the Inngest platform,
which enable developers to run reliable background logic, from background jobs to complex workflows. They provide robust tools for retrying, scheduling, and coordinating complex sequences of operations. They are composed of [steps](#inngest-step) that can run independently and be retried in case of failure. Inngest functions are powered by [Durable Execution](#durable-execution), ensuring reliability and fault tolerance, and can be deployed on any platform, including serverless environments. Read more about [Inngest Functions](/docs/learn/inngest-functions).

## Inngest Step
Expand Down Expand Up @@ -95,7 +95,7 @@ Throttling is one of the methods offered by Inngest's [Flow Control](#flow-contr

## Next Steps

- Explore Inngest through our [Quick Start](/docs/getting-started/nextjs-quick-start).
- Explore Inngest through our [Quick Start](/docs/getting-started/nextjs-quick-start?ref=docs-glossary).
- Learn about [Inngest Functions](/docs/learn/inngest-functions).
- Learn about [Inngest Steps](/docs/learn/inngest-steps).
- Understand how [Inngest functions are executed](/docs/learn/how-functions-are-executed).
Expand Down
2 changes: 1 addition & 1 deletion pages/docs/learn/inngest-functions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ This is useful when you need to break down complex workflows into simpler, manag

## Further reading

- [Quick Start guide](/docs/getting-started/nextjs-quick-start): learn how to build complex workflows.
- [Quick Start guide](/docs/getting-started/nextjs-quick-start?ref=docs-inngest-functions): learn how to build complex workflows.
- ["How Inngest functions are executed"](/docs/learn/how-functions-are-executed): learn more about Inngest's execution model.
- ["Inngest steps"](/docs/learn/inngest-steps): understand building Inngest's blocks.
- ["Flow Control"](/docs/guides/flow-control): learn how to manage execution within Inngest functions.
2 changes: 1 addition & 1 deletion pages/docs/learn/inngest-steps.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,6 @@ export default inngest.createFunction(

## Further reading

- [Quick Start](/docs/getting-started/nextjs-quick-start): learn how to build complex workflows.
- [Quick Start](/docs/getting-started/nextjs-quick-start?ref=docs-inngest-steps): learn how to build complex workflows.
- ["How Inngest functions are executed"](/docs/learn/how-functions-are-executed): Learn more about Inngest's execution model, including how steps are handled.
- Docs guide: ["Multi-step functions"](/docs/guides/multi-step-functions).
27 changes: 0 additions & 27 deletions shared/Header/Dropdown/FeaturedLink.tsx

This file was deleted.

18 changes: 0 additions & 18 deletions shared/Header/Dropdown/NavLink.tsx

This file was deleted.

36 changes: 0 additions & 36 deletions shared/Header/Dropdown/index.tsx

This file was deleted.

109 changes: 0 additions & 109 deletions shared/Header/headerLinks.ts

This file was deleted.

Loading

0 comments on commit ee1c8a9

Please sign in to comment.