This repository contains the Wonderland Handbook, a documentation site built with Docusaurus. The handbook serves as a central knowledge base for Wonderland's processes, guidelines, and best practices.
handbook/
- Contains the Docusaurus website source codedocs/
- Documentation content in Markdown formatsrc/
- Custom React components and stylesdocusaurus.config.js
- Main Docusaurus configuration
- Node.js (v16 or higher)
- Yarn package manager
- Install dependencies:
cd handbook
npm i
- Start the development server:
npm run start
This will start a local development server and open your browser. Changes are reflected in real-time.
To create a production build:
cd handbook
npm run build
The static site will be generated in the handbook/build
directory.
The handbook is automatically deployed to Vercel when changes are pushed to the main branch.
- Create a new branch for your changes
- Make your changes in the
handbook/docs
directory - Test locally using
npm run start
- 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!