README.md

Basedash Documentation

This repository contains the documentation for Basedash, our AI-native business intelligence platform. This guide will help you get set up and make changes to the documentation.

Initial Setup

1. Install Required Software

   • Install Git if you don't have it
   • Install Node.js (which includes npm)
   • Install Cursor - this is the AI-powered editor we use

2. Clone the Repository Open Terminal and run these commands:

   cd Documents  # or wherever you want to store the project
   git clone https://github.com/Basedash/docs.git
   cd docs

3. Install Dependencies

   npm i -g mintlify  # Install Mintlify CLI globally

Making Changes

You'll need to follow these steps every time you want to make a change.

1. Get Latest Changes Before making any changes, always get the latest updates:

   git pull origin main

2. Using Cursor

   • Open Cursor
   • Choose "Open Folder" and select the docs folder
   • Press ⌘I to activate the AI assistant
   • Type your request in plain English, and the AI will help you make changes

3. Testing Your Changes To preview your changes locally, run:

   mintlify dev

   This will start a local server at http://localhost:3000 where you can preview the changes.

4. Saving Your Changes After making changes, run:

   git add .
   git commit -m "Describe your changes briefly here"
   git push origin main

Troubleshooting

• If mintlify dev isn't working:
  • Run mintlify install to reinstall dependencies
• If a page shows as 404:
  • Make sure you're in the correct folder with docs.json

Publishing

Changes will automatically be deployed to production after pushing to the main branch.

Need Help?

If you get stuck at any point:

1. Use the Cursor AI to ask for help
2. Reach out to the development team on Slack
3. Check the Mintlify documentation