Railway Documentation

This is the official documentation for Railway. You can view it at docs.railway.com.

Local Development

You'll need to have Node.js and pnpm installed. You can then install dependencies and start the development server by running the following commands:

pnpm install
pnpm dev

Open localhost:3001 to see the docs.

Available Commands

| Command | Description | |---------|-------------| | pnpm dev | Start development server on port 3001 | | pnpm build | Create production build | | pnpm start | Start production server | | pnpm clean | Remove build artifacts |

Local Search Setup

Search is powered by Meilisearch. To test search functionality locally, you'll need Docker.

Prerequisites

Copy the environment file to enable local search in the frontend:

cp .env.example .env.local

Search Commands

| Command | Description | |---------|-------------| | pnpm search:start | Start the Meilisearch container | | pnpm search:stop | Stop the Meilisearch container | | pnpm search:build | Index local docs (requires dev server running) | | pnpm search:setup | Start Meilisearch and index docs in one command |

Quick Setup

1. Start the dev server in one terminal:

pnpm dev

1. In another terminal, run the full search setup:

pnpm search:setup

This starts Meilisearch on port 7700 and crawls your local dev server to index all documentation pages. The search bar will connect to Meilisearch using the environment variables from .env.local.

Contributing

Contributions from the community are welcome! Please read the Contributing Guide for details on how to submit changes.