Thanks to visit codestin.com
Credit goes to github.com

Skip to content

IllumiChat/docs

Repository files navigation

IllumiChat Documentation

This repository contains the official documentation for IllumiChat, the AI assistant builder platform.

About IllumiChat

IllumiChat is a complete platform for creating intelligent AI assistants with your own knowledge base, seamless integrations, and powerful deployment options. Build assistants that can:

  • Answer questions using your custom knowledge base
  • Integrate with HubSpot, Jira, and other tools via MCP
  • Deploy as chat widgets, API integrations, or platform bots
  • Scale from simple Q&A to complex workflows

Documentation Structure

  • Getting Started: Introduction, quick start guide, and core concepts
  • User Guide: Step-by-step instructions for using IllumiChat
  • API Reference: Complete API documentation for developers
  • Integrations: MCP setup guides and webhook configuration
  • Troubleshooting: Common issues and support resources

Local Development

Prerequisites

  • Node.js 18+ installed
  • Mintlify CLI installed: npm i -g mint

Running Locally

  1. Clone this repository
  2. Install dependencies: npm install
  3. Start the development server: mint dev
  4. Open http://localhost:3000

Making Changes

  • Edit .mdx files in the appropriate directories
  • Update docs.json for navigation changes
  • Preview changes in real-time with the dev server
  • Commit and push to deploy automatically

Contributing

We welcome contributions to improve our documentation:

  1. Fork this repository
  2. Create a feature branch
  3. Make your changes
  4. Submit a pull request

Support

License

This documentation is licensed under the Creative Commons ShareAlike 4.0 License.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages