docs.boreal.chat

This is the official documentation for boreal.chat - a free and open-source AI chat platform. The documentation is built with Astro and Starlight.

🚀 Getting Started

Prerequisites

• Node.js (version 20 or higher)
• pnpm (recommended package manager)

Installation

1. Clone the repository:

   git clone https://github.com/wosherco/docs.boreal.chat.git
   cd docs.boreal.chat

2. Install dependencies:

   pnpm install

3. Start the development server:

   pnpm dev

4. Open http://localhost:4321 in your browser

📁 Project Structure

src/
├── content/
│   └── docs/           # Documentation pages
│       ├── index.mdx   # Homepage
│       └── beta-docs/  # Beta documentation
└── content.config.ts   # Content collections config

🛠️ Available Commands

Command	Action
pnpm install	Install dependencies
pnpm dev	Start local dev server at localhost:4321
pnpm build	Build production site to ./dist/
pnpm preview	Preview your build locally, before deploying

📝 Contributing

We welcome contributions! Please see our Contributing Guide for details on how to contribute to the documentation.

📞 Contact

• Discord: Join our community
• Email: contact@boreal.chat
• X (Twitter): @borealchat
• GitHub: wosherco/boreal.chat

📄 License

This documentation is part of the boreal.chat project and follows the same licensing terms.

---

Note

This documentation is a work in progress. We're continuously updating and improving it.