Skip to main content
Prerequisites:
  • Node.js version 22 or higher
  • Git (for version control)
  • A code editor (VS Code recommended)

​
Getting Started

To contribute to the Pandabase documentation, follow these steps:
1

Clone the repository

git clone https://github.com/pandabase/docs.git
cd docs
2

Install Mintlify

npm i -g mint
3

Run the development server

mint dev
The documentation will be available at http://localhost:3000.

​
File Structure

All documentation files are written in MDX format and organized as follows:
  • /developers - API documentation and developer guides
  • /guides - User guides and tutorials
  • /images - Images and assets

​
Making Changes

  1. Create a new branch for your changes
  2. Edit the relevant .mdx files
  3. Preview your changes locally
  4. Submit a pull request

​
Code Formatting

We recommend using these VS Code extensions:
  • MDX for syntax highlighting
  • Prettier for code formatting