Installation

To run the Documentation Site locally:

Prerequisites

• Node.js (v20+)
• pnpm (v10.4.1+)

Steps

1. Install dependencies from root:

   # From the project root
   pnpm install
   

2. Run Development Server: From the root directory, run:

   pnpm dev:web
   

   Or to run only the docs site:

   pnpm dev --filter=docs
   

   This command will automatically run the Contentlayer build process to generate the content cache.

3. View Site: Open http://localhost:3001 in your browser.

Troubleshooting

Content Errors

If you encounter content errors, try clearing the Contentlayer cache:

cd apps/docs
rm -rf .contentlayer
pnpm dev

Build Before Development

The documentation site requires a successful build before development. If you encounter errors on first run:

cd apps/docs
pnpm build
pnpm dev

This ensures Contentlayer has properly indexed all MDX files in the content/ directory.