Skip to content

MayaResearch/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Maya Research API Documentation

This repository contains the documentation for Maya Research APIs, built with Mintlify.

📚 Documentation Structure

  • VeenaMAX TTS API - Advanced Text-to-Speech API for Indian languages
  • API Reference - Interactive API playground and endpoints
  • Getting Started - Quick start guides and tutorials

🚀 Local Development

Prerequisites

  • Node.js 18+ installed
  • npm or yarn package manager

Installation

  1. Install Mintlify CLI globally:
npm install -g mintlify
  1. Navigate to the docs directory:
cd /Users/sthipp005/Documents/personal/mayaresearch/docs
  1. Start the development server:
mintlify dev

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

📝 Making Changes

  1. Edit .mdx files for content changes
  2. Update docs.json for navigation and configuration
  3. Modify openapi.yaml for API specification updates

🌐 Deployment

Deploy to Mintlify hosting:

mintlify deploy

Build for self-hosting:

mintlify build

📁 Project Structure

docs/
├── index.mdx                           # Home page
├── veenamax-tts-api.mdx               # VeenaMAX overview
├── api-reference/
│   ├── endpoint/
│   │   └── veenamax-generate.mdx      # API endpoint documentation
│   └── openapi.yaml                   # OpenAPI specification
├── docs.json                          # Mintlify configuration
└── README.md                          # This file

🔗 Important Links

🎨 Customization

  • Colors: Purple theme (#7C3AED primary)
  • Logo: Place your logo files in /logo/ directory
  • Favicon: Update /favicon.svg

📊 Analytics

Update the GTM tag ID in docs.json:

"analytics": {
  "gtm": {
    "tagId": "GTM-YOUR-ID"
  }
}

🤝 Support

For any questions or issues, contact: support@mayaresearch.ai


Built with ❤️ by Maya Research

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages