Optimism Handbook by Wonderland

This repository contains the Onboarding to Optimism by Wonderland, a documentation site built with Docusaurus. The OP handbook serves as a central knowledge base for the researchers, devs and architects involved in the protocol.

Structure

• handbook/ - Contains the Docusaurus website source code
  • docs/ - Documentation content in Markdown format
  • src/ - Custom React components and styles
  • docusaurus.config.js - Main Docusaurus configuration
  • sidebar.ts - Indexer for the docs

Development

Prerequisites

• Node.js (v16 or higher)
• Yarn package manager

Local Development

1. Install dependencies:

cd op-handbook
npm i

2. Start the development server:

npm run start

This will start a local development server and open your browser. Changes are reflected in real-time.

Building for Production

To create a production build:

cd op-handbook
npm run build

The static site will be generated in the op-handbook/build directory.

Deployment

The handbook is automatically deployed to Vercel when changes are pushed to the main branch.

Contributing

1. Create a new branch for your changes
2. Make your changes in the op-handbook/docs directory
3. Test locally using npm run start
4. Submit a pull request

If you have any ideas for improving the handbook, feel free to open an issue (check the templates!) to start a discussion!