Recorder Documentation

This repository contains the source code for the official documentation of the Recorder project.

The documentation website is built with Docusaurus.

Getting Started

Prerequisites

• Node.js (version 18.0 or above)
• pnpm

Local Development

1. Clone the repository:

   git clone https://github.com/TokenRollAI/recorder-doc.git
   cd recorder-doc

2. Install dependencies:

   pnpm install

3. Start the development server:

   pnpm start

   This will open the documentation website in your browser at http://localhost:3000. Most changes will be reflected live without needing to restart the server.

Building the Website

To generate a static build of the website, run:

pnpm build

The static files will be placed in the build directory.

Contributing

We welcome contributions to improve the documentation. Please feel free to open issues or submit pull requests.