xpander.ai Documentation

This repository contains the documentation for xpander.ai, built with Mintlify.

🌐 Live Documentation: https://docs.xpander.ai

Quick Start: Click the "Open in GitHub Codespaces" button above to instantly start reviewing or contributing to the documentation. No local setup required!

🚀 Getting Started with GitHub Codespaces

GitHub Codespaces provides a complete, ready-to-use development environment in your browser. This is the easiest way to preview documentation changes and review PRs.

Quick Start

1. Open in Codespaces

   • Click the green "Code" button on this repository
   • Select the "Codespaces" tab
   • Click "Create codespace on main" (or your branch)

2. Start the Documentation Server Once your Codespace is ready, run:

   npm install
   npm run dev

3. Preview the Documentation

   • The documentation will be available at http://localhost:3000
   • Codespaces will automatically forward the port and show a notification
   • Click "Open in Browser" when prompted

Available Commands

Command	Description
npm install	Install dependencies (including Mintlify CLI)
npm run dev	Start the development server with hot reload
npm run build	Build the documentation for production
npm run preview	Preview the production build locally

Reviewing Pull Requests

Note for Reviewers: GitHub automatically shows an "Open with Codespaces" button on all pull requests. Simply click it to launch a pre-configured environment with all changes ready to preview!

1. Open PR in Codespaces (Single Click!)

   • On any Pull Request page, look for the green "Code" dropdown
   • Click "Open with Codespaces"
   • A new Codespace will launch with the PR's changes automatically loaded
   • No local setup or installation required!

2. Preview Changes (Automatic)

   • Codespaces will automatically run npm install during setup
   • Simply run: npm run dev
   • The preview URL will appear automatically

3. Visual Review

   • Navigate through the documentation at http://localhost:3000
   • Check for formatting issues, broken links, and content accuracy
   • Test the search functionality
   • Verify images and code snippets render correctly
   • Leave feedback directly in the PR while viewing changes live

🖥️ Local Development

If you prefer to work locally:

Prerequisites

• Node.js 18.x or higher
• npm or yarn

Setup

# Clone the repository
git clone https://github.com/xpander-ai/docs.git
cd docs

# Install dependencies
npm install

# Start the development server
npm run dev

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

📝 Writing Documentation

File Structure

• /docs/ - Main documentation content
• /tutorials/ - Step-by-step tutorials
• /workshops/ - Workshop materials
• /templates/ - Reusable templates
• /api-reference/ - API documentation
• /connectors/ - Connector documentation
• /images/ - Images and screenshots
• /static/ - Static assets

MDX Format

Documentation is written in MDX format, which allows you to use React components within Markdown. See Mintlify's documentation for available components.

Adding New Pages

1. Create a new .mdx file in the appropriate directory
2. Add frontmatter with title, description, and icon
3. Update docs.json to include the new page in navigation

Example frontmatter:

---
title: "Page Title"
description: "Brief description of the page"
icon: "rocket"
---

🔄 Contributing

Automatic Codespaces for All PRs and Branches

Important: This repository is configured to automatically offer GitHub Codespaces for all pull requests and feature branches. No additional setup is required!

• ✅ Automatic for PRs: Every pull request shows an "Open with Codespaces" button
• ✅ Works on all branches: Create a Codespace from any branch instantly
• ✅ Zero configuration: Everything is pre-configured and ready to use
• ✅ Free for contributors: Uses GitHub's free Codespaces tier

Contributing Steps

1. Fork the repository
2. Click to start developing
3. Make your changes in the cloud-based environment
4. Test your changes with npm run dev
5. Commit and push directly from Codespaces
6. Open a Pull Request
7. Reviewers can instantly preview your changes using Codespaces

For contribution guidelines, please refer to our community Slack or Discord channels listed in the documentation.

🛠️ Troubleshooting

Codespaces Issues

• Port forwarding not working: Check the "Ports" tab in the Codespaces terminal
• Mintlify CLI not found: Run npm install -g mintlify@latest
• Build errors: Clear cache with rm -rf .mintlify and rebuild

Common Issues

• Changes not reflecting: Hard refresh your browser (Ctrl/Cmd + Shift + R)
• Search not working: Rebuild the search index with npm run build

📞 Support

• Join our Community Slack
• Visit our Developer Discord
• Open an issue in this repository

📄 License

This documentation is licensed under the MIT License. See the LICENSE file for details.