DEVELOPPEMENT.md

Meeting BaaS Documentation

This is a Next.js application using Fumadocs for generating and maintaining Meeting BaaS service documentation.

Development

Run development server:

# Start development server
pnpm dev

# Build for production
pnpm build

Open http://localhost:3000 with your browser to see the result.

Documentation Updates

The project includes several scripts for managing documentation updates:

Enhancing Update Files with AI

The project includes an AI-powered enhancement script that uses OpenRouter (with Anthropic's Claude models) to improve automatically generated documentation:

# Enhance the most recent update file
pnpm enhance:updates --key=your_openrouter_api_key

# Process all update files
pnpm enhance:updates --key=your_openrouter_api_key --all

# Process updates for a specific service
pnpm enhance:updates --key=your_openrouter_api_key --service=api

# Process updates for a specific date
pnpm enhance:updates --key=your_openrouter_api_key --date=2023-10-15

# Use a different model
pnpm enhance:updates --key=your_openrouter_api_key --model=anthropic/claude-3-opus-20240229

# Enable verbose logging
pnpm enhance:updates --key=your_openrouter_api_key --verbose

You will need to obtain an OpenRouter API key from openrouter.ai to use this feature.

Prompt System

The project uses a centralized prompt system in scripts/prompts.ts to manage all AI enhancement prompts. This system:

1. Organizes prompts into categories:

   • codingStyle: Fumadocs components and usage examples
   • instructions: Enhancement guidelines and rules
   • templates: Reusable templates for headers and footers
   • formatting: Code blocks and table formatting
   • metadata: Valid update types and services
   • validation: Required fields and validation rules

2. Provides helper functions:

   // Get a specific prompt
   const prompt = getPrompt('codingStyle', 'fumadocsComponents');
   
   // Get all prompts for a category
   const allInstructions = getCategoryPrompts('instructions');

3. Includes type definitions for type safety:

   type PromptCategory = 'codingStyle' | 'instructions' | 'templates' | 'formatting' | 'metadata' | 'validation';

4. Maintains consistent formatting and rules across all generated content

The prompt system ensures consistent documentation quality and makes it easy to update enhancement rules and templates.

Git Diff Updates

Updates are automatically generated from git diff files in the git_greppers directory. These updates include service-specific styling with colored icons in the sidebar.

Setting Up Local Git Repositories

The project includes a script to automatically collect Git diffs from local repositories:

# Make the script executable
chmod +x git_greppers/local-git-setup.sh

# Run the setup script
./git_greppers/local-git-setup.sh

This script will:

1. Process the repositories defined in the configuration
2. Generate diff files in the appropriate folders
3. Clean existing git updates
4. Generate new update files based on the diffs

You can also run the git grepper script directly with various options:

# Basic usage
./git_greppers/git_grepper.sh /path/to/repo [debug_level] [flags]

# Available flags:
#   --no-diff           Skip generating diffs (faster for large repositories)
#   --only-with-pr-mr   Only process commits with related PR/MR references
#   --overwrite         Overwrite existing files (default: skip existing files)
#   --days N            Number of days to look back (default: 7)

# Examples:
# Process with debug level 3 and only PR/MR commits
./git_greppers/git_grepper.sh /path/to/repo 3 --only-with-pr-mr

# Process and overwrite existing files
./git_greppers/git_grepper.sh /path/to/repo 3 --overwrite

# Skip diffs and only process PR/MR commits
./git_greppers/git_grepper.sh /path/to/repo 3 --no-diff --only-with-pr-mr

# Process commits from the last 14 days
./git_greppers/git_grepper.sh /path/to/repo 3 --days 14

You need to configure your repository paths in git_greppers/config.json:

{
  "repositories": {
    "meeting-baas": "/path/to/meeting-baas",
    "speaking-meeting-bot": "/path/to/speaking-meeting-bot",
    "sdk-generator": "/path/to/sdk-generator",
    "mcp-on-vercel": "/path/to/mcp-on-vercel",
    "mcp-on-vercel-documentation": "/path/to/mcp-on-vercel-documentation",
    "mcp-baas": "/path/to/mcp-baas"
  }
}

Each path should point to a valid Git repository that you want to include in the documentation updates.

Requirements

• jq is required for parsing the configuration file. Install it using:

  brew install jq

Basic Commands

# Clean all git update files
pnpm clean:git-updates

# Generate git diff updates (non-destructive - only creates new files)
pnpm test:git-updates

# Regenerate all git diff updates (destructive - deletes and recreates all files)
pnpm regenerate:git-updates

# Update a single repository (e.g., speaking-meeting-bot)
pnpm update:speaking-bots

# Update any repository by name
pnpm update:repo $REPO

# Setup git updates - cleans and regenerates
pnpm setup:git-updates

Important Note:

• test:git-updates only creates new files without modifying existing ones
• regenerate:git-updates deletes all existing update files before creating new ones (will overwrite customized files)
• If you've customized any update files, prefer using test:git-updates to preserve your changes

Cleaning Old Git Diff Files

To remove all old generated git diff files (for a full refresh or to save disk space), run:

rm git_greppers/*-git-diffs/diffs-*.diff

This will delete all files named diffs-YYYY-MM-DD.diff in every repository's git diff directory under git_greppers/. You can also remove log files if desired:

rm git_greppers/*-git-diffs/*