Skip to content

Documentation and website for Celeste AI - Fumadocs-based documentation site

Notifications You must be signed in to change notification settings

Seluj78/celeste-docs

 
 

Repository files navigation

Celeste Logo

Celeste AI Documentation

Documentation site for Celeste AI

Built with Next.js and Fumadocs.

Next.js Fumadocs Tailwind CSS Biome License

DocumentationGitHub


🚀 Quick Start

Prerequisites

  • Bun (v1.0+) - Package manager
  • Node.js 20+ (for Bun compatibility)

Installation

# Install dependencies
bun install

Development

# Start development server
bun run dev

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

Build

# Build for production
bun run build

# Start production server
bun run start

📚 Documentation Structure

The documentation is organized into the following sections:

  • Getting Started: Installation and quick start guides
  • Core Concepts: Client, modalities, and providers
  • Modalities: Text, image, video, and speech generation
  • Providers: Provider-specific documentation
  • Guides: Streaming, error handling, and multi-modal workflows

🛠️ Development

Code Quality

# Format code
bun run format

# Lint code
bun run lint

# Type check
bun run typecheck

# Run full CI pipeline
make ci

Git Hooks

Lefthook is configured for pre-commit hooks. Install hooks:

bunx lefthook install

📖 Learn More


🤝 Contributing

We welcome contributions! See CONTRIBUTING.md for guidelines.

Report issues: GitHub Issues


📄 License

MIT license – see LICENSE for details.


View DocumentationGitHubCeleste Python

Made with ❤️ by developers tired of framework lock-in

About

Documentation and website for Celeste AI - Fumadocs-based documentation site

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • MDX 49.6%
  • TypeScript 30.6%
  • Python 13.6%
  • CSS 5.6%
  • Other 0.6%