Skip to content

Commit

Permalink
Fix broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
haydenbleasel committed Dec 14, 2024
1 parent ac020c4 commit 0661f38
Show file tree
Hide file tree
Showing 19 changed files with 46 additions and 38 deletions.
2 changes: 1 addition & 1 deletion docs/deployment/netlify.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ Finally, just hit "Deploy" and Netlify will take care of the rest!

## Environment variables

If you're deploying on Netlify, we recommend making use of the Shared Environment Variables feature. Variables used by libraries need to exist in all packages and duplicating them can be a headache. Learn more about how [environment variables](/features/env) work in next-forge.
If you're deploying on Netlify, we recommend making use of the Shared Environment Variables feature. Variables used by libraries need to exist in all packages and duplicating them can be a headache. Learn more about how [environment variables](/packages/env) work in next-forge.
4 changes: 2 additions & 2 deletions docs/deployment/vercel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ Want to see it in action? next-forge is featured on the [Vercel Marketplace](htt

## Environment variables

If you're deploying on Vercel, we recommend making use of the Team Environment Variables feature. Variables used by libraries need to exist in all packages and duplicating them can be a headache. Learn more about how [environment variables](/features/env) work in next-forge.
If you're deploying on Vercel, we recommend making use of the Team Environment Variables feature. Variables used by libraries need to exist in all packages and duplicating them can be a headache. Learn more about how [environment variables](/packages/env) work in next-forge.

## Integrations

We also recommend installing the [BetterStack](https://vercel.com/integrations/betterstack) and [Sentry](https://vercel.com/integrations/sentry) integrations. This will take care of the relevant [environment variables](/features/env).
We also recommend installing the [BetterStack](https://vercel.com/integrations/betterstack) and [Sentry](https://vercel.com/integrations/sentry) integrations. This will take care of the relevant [environment variables](/packages/env).

2 changes: 1 addition & 1 deletion docs/migrations/storage/upload-thing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ export { withUt as withStorage } from 'uploadthing/tw';

## 5. Create a file router in your app

Create a new file in your app's `lib` directory to define the file router. This file will be used to define the file routes for your app, using your [Auth](/features/auth) package to get the current user.
Create a new file in your app's `lib` directory to define the file router. This file will be used to define the file routes for your app, using your [Auth](/packages/authentication) package to get the current user.

```ts apps/app/app/lib/upload.ts
import { currentUser } from '@repo/auth/server';
Expand Down
12 changes: 10 additions & 2 deletions docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,15 @@
},
{
"source": "/documentation",
"destination": "/structure/apps/docs"
"destination": "/apps/docs"
},
{
"source": "/structure/apps",
"destination": "/apps"
},
{
"source": "/structure/packages",
"destination": "/packages"
},
{
"source": "/documentation/fumadocs",
Expand Down Expand Up @@ -348,7 +356,7 @@
},
{
"source": "/storybook",
"destination": "/structure/apps/storybook"
"destination": "/apps/storybook"
},
{
"source": "/webhooks",
Expand Down
18 changes: 9 additions & 9 deletions docs/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@ The monorepo contains the following apps:

| App | Documentation | Port | Recommended URL |
| --- | ----------- | ---- | --------------- |
| `api` | [API](/structure/apps/api) | 3002 | `api.acme.com` |
| `app` | [App](/structure/apps/app) | 3000 | `app.acme.com` |
| `docs` | [Docs](/structure/apps/docs) | 3004 | `docs.acme.com` |
| `email` | [Email](/structure/apps/email) | 3003 | |
| `storybook` | [Storybook](/structure/apps/storybook) | 6006 | |
| `studio` | [Studio](/structure/apps/studio) | 3005 | |
| `web` | [Web](/structure/apps/web) | 3001 | `acme.com` |

While you can choose to run these apps on the subdomain of your choice, the recommended subdomains are listed above. Remember to add them to your [environment variables](/features/env) under `NEXT_PUBLIC_APP_URL`, `NEXT_PUBLIC_WEB_URL`, and `NEXT_PUBLIC_DOCS_URL`.
| `api` | [API](/apps/api) | 3002 | `api.acme.com` |
| `app` | [App](/apps/app) | 3000 | `app.acme.com` |
| `docs` | [Docs](/apps/docs) | 3004 | `docs.acme.com` |
| `email` | [Email](/apps/email) | 3003 | |
| `storybook` | [Storybook](/apps/storybook) | 6006 | |
| `studio` | [Studio](/apps/studio) | 3005 | |
| `web` | [Web](/apps/web) | 3001 | `acme.com` |

While you can choose to run these apps on the subdomain of your choice, the recommended subdomains are listed above. Remember to add them to your [environment variables](/packages/env) under `NEXT_PUBLIC_APP_URL`, `NEXT_PUBLIC_WEB_URL`, and `NEXT_PUBLIC_DOCS_URL`.

## Philosophy

Expand Down
2 changes: 1 addition & 1 deletion docs/packages/authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ next-forge manages authentication through the use of a `auth` package. By defaul

## In-App

The `@repo/auth` package exposes an `AuthProvider`, however you don't need to use this directly. The [`DesignSystemProvider`](/features/design-system/provider) includes all relevant providers and higher-order components.
The `@repo/auth` package exposes an `AuthProvider`, however you don't need to use this directly. The [`DesignSystemProvider`](/packages/design-system/provider) includes all relevant providers and higher-order components.

From here, you can use all the pre-built components and hooks provided by Clerk. To demonstrate this, we've added the `<OrganizationSwitcher>` and `<UserButton>` components to the sidebar, as well as built out the Sign In and Sign Up pages.

Expand Down
2 changes: 1 addition & 1 deletion docs/packages/cms.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Keep this connection string handy, you will need it in the next step.

### 2. Update your environment variables

Update your [environment variables](/features/env) to use the new BaseHub token. For example:
Update your [environment variables](/packages/env) to use the new BaseHub token. For example:

```ts apps/web/.env
BASEHUB_TOKEN="<token>"
Expand Down
2 changes: 1 addition & 1 deletion docs/packages/database.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,4 @@ This runs the following commands:

## Visual database editor

next-forge includes a [visual database editor](/structure/apps/studio) that allows you to view and edit your database records.
next-forge includes a [visual database editor](/apps/studio) that allows you to view and edit your database records.
2 changes: 1 addition & 1 deletion docs/packages/design-system/colors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Colors
description: CSS variables and how they work
---

next-forge makes use of the CSS variables offered by [shadcn/ui](https://ui.shadcn.com/). They're a brilliant way of abstracting the scaling and maintenance difficulties associated with [Dark Mode](/features/design-system/dark-mode) and whitelabelling.
next-forge makes use of the CSS variables offered by [shadcn/ui](https://ui.shadcn.com/). They're a brilliant way of abstracting the scaling and maintenance difficulties associated with [Dark Mode](/packages/design-system/dark-mode) and whitelabelling.

These colors have also been applied to other tools, such as the `AuthProvider`, to ensure that third-party components align with the application design as closely as possible.

Expand Down
2 changes: 1 addition & 1 deletion docs/packages/design-system/provider.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: A single global provider to wrap your application

The design system package also exports a `DesignSystemProvider` component which implements a number of contextual, functional and higher order components, including those for Tooltips, Toasts, Analytics, Dark Mode and more.

This provider is already added to the default apps. If you want to add a new app, make sure you add it to your root layout along with [fonts](/features/design-system/typography) and global CSS, like so:
This provider is already added to the default apps. If you want to add a new app, make sure you add it to your root layout along with [fonts](/packages/design-system/typography) and global CSS, like so:

```tsx layout.tsx
import '@repo/design-system/styles/globals.css';
Expand Down
2 changes: 1 addition & 1 deletion docs/packages/email.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ await resend.emails.send({

## Previewing Emails

To preview the emails templates, simply run the [`email` app](/structure/apps/email).
To preview the emails templates, simply run the [`email` app](/apps/email).
2 changes: 1 addition & 1 deletion docs/packages/flags.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Feature flags (also known as feature toggles) allow you to control access to spe

next-forge implements feature flags using Vercel's [Flags SDK](https://vercel.com/docs/workflow-collaboration/feature-flags/flags-pattern-nextjs), which is mostly an architectural pattern for working with feature flags. This setup exists in the `@repo/feature-flags` package, so you can import and use it in as many projects as you'd like.

We've created an intelligent function called `createFlag` that you can use to create new flags, complete with authentication, PostHog integration and [Vercel Toolbar](/features/toolbar) overrides without the hassle.
We've created an intelligent function called `createFlag` that you can use to create new flags, complete with authentication, PostHog integration and [Vercel Toolbar](/packages/toolbar) overrides without the hassle.

## Adding a new flag

Expand Down
2 changes: 1 addition & 1 deletion docs/packages/payments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Stripe Radar supports more [advanced anti-fraud features](https://docs.stripe.co
Add the same script to the website in `apps/web/app/layout.tsx`.
</Step>
<Step title="Prevent common fraud patterns with Arcjet">
Prevent common fraud patterns by using [Arcjet](/features/security/application) [IP address analysis](https://docs.arcjet.com/reference/nextjs#ip-analysis) to [block requests from VPNs and proxies](https://docs.arcjet.com/blueprints/vpn-proxy-detection). These are commonly used by fraudsters to hide their location, but have legitimate uses as well so are not blocked by default. You could simply block these users, or you could adjust the checkout process to require approval before processing their payment.
Prevent common fraud patterns by using [Arcjet](/packages/security/application) [IP address analysis](https://docs.arcjet.com/reference/nextjs#ip-analysis) to [block requests from VPNs and proxies](https://docs.arcjet.com/blueprints/vpn-proxy-detection). These are commonly used by fraudsters to hide their location, but have legitimate uses as well so are not blocked by default. You could simply block these users, or you could adjust the checkout process to require approval before processing their payment.
</Step>
</Steps>

Expand Down
2 changes: 1 addition & 1 deletion docs/packages/security/ip-geolocation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ import { Authors } from '/snippets/authors.mdx';
},
}]} />

next-forge uses [Arcjet](https://arcjet.com) for [application security](/features/security/application) which includes [IP details and geolocation information](https://docs.arcjet.com/reference/nextjs#ip-analysis) you can use in your application.
next-forge uses [Arcjet](https://arcjet.com) for [application security](/packages/security/application) which includes [IP details and geolocation information](https://docs.arcjet.com/reference/nextjs#ip-analysis) you can use in your application.

In the `app` application, Arcjet is called in the `apps/app/app/(authenticated)/layout.tsx` file which runs on every authenticated route.

Expand Down
2 changes: 1 addition & 1 deletion docs/packages/security/rate-limiting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Rate limiting is enabled for the `web` package contact form automatically by the

To get your environment variables, you can sign up at [Upstash Console](https://console.upstash.com) and create a Redis KV database. You can then find the REST URL and REST token in the database details page.

You can then paste these environment variables each of the [environment variables](/features/env) files.
You can then paste these environment variables each of the [environment variables](/packages/env) files.

## Adding rate limiting

Expand Down
2 changes: 1 addition & 1 deletion docs/recipes/ai-chatbot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This will create a new project with the name `ai-chatbot` and install the necess

## 2. Configure your environment variables

Follow the guide on [Environment Variables](/features/env) to fill in your environment variables.
Follow the guide on [Environment Variables](/packages/env) to fill in your environment variables.

Specifically, make sure you set an `OPENAI_API_KEY` environment variable.

Expand Down
2 changes: 1 addition & 1 deletion docs/setup/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ You should change the environment variables in each `.env` or `.env.local` file
DATABASE_URL="postgres://..."
```

Read more about environment variables [here](/features/env).
Read more about environment variables [here](/packages/env).

## Database

Expand Down
20 changes: 10 additions & 10 deletions docs/setup/prerequisites.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Learn how to [install pnpm](https://pnpm.io/installation).

## Stripe CLI

We use the Stripe CLI to forward webhooks to your local machine. You can read more about that [here](/features/payments).
We use the Stripe CLI to forward webhooks to your local machine. You can read more about that [here](/packages/payments).

Learn how to [install the Stripe CLI](https://docs.stripe.com/stripe-cli) for your operating system.

Expand All @@ -45,13 +45,13 @@ pnpm add -g @mintlify/cli

## Accounts

next-forge relies on various SaaS products. You will need to create accounts with the following services then set the API keys in your [environment variables](/features/env):
next-forge relies on various SaaS products. You will need to create accounts with the following services then set the API keys in your [environment variables](/packages/env):

- [Arcjet](https://arcjet.com), for [application security](/features/security/application).
- [BetterStack](https://betterstack.com), for [logging](/features/observability/logging) and [uptime monitoring](/features/observability/uptime).
- [Clerk](https://clerk.com), for [authentication](/features/authentication).
- [Google Analytics](https://developers.google.com/analytics), for [web analytics](/features/analytics/web).
- [Posthog](https://posthog.com), for [product analytics](/features/analytics/product).
- [Resend](https://resend.com), for [transactional emails](/features/email/resend).
- [Sentry](https://sentry.io), for [error tracking](/features/observability/error-capture).
- [Stripe](https://stripe.com), for [payments](/features/payments).
- [Arcjet](https://arcjet.com), for [application security](/packages/security/application).
- [BetterStack](https://betterstack.com), for [logging](/packages/observability/logging) and [uptime monitoring](/packages/observability/uptime).
- [Clerk](https://clerk.com), for [authentication](/packages/authentication).
- [Google Analytics](https://developers.google.com/analytics), for [web analytics](/packages/analytics/web).
- [Posthog](https://posthog.com), for [product analytics](/packages/analytics/product).
- [Resend](https://resend.com), for [transactional emails](/packages/email).
- [Sentry](https://sentry.io), for [error tracking](/packages/observability/error-capture).
- [Stripe](https://stripe.com), for [payments](/packages/payments).
2 changes: 1 addition & 1 deletion docs/updates.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ pnpm bump-deps

## Upgrading shadcn/ui components

You can upgrade all the shadcn/ui components in the [Design System](/features/design-system/components) package with the `bump-ui` command:
You can upgrade all the shadcn/ui components in the [Design System](/packages/design-system/components) package with the `bump-ui` command:

```sh Terminal
pnpm bump-ui
Expand Down

0 comments on commit 0661f38

Please sign in to comment.