Skip to content

SugarAI-HQ/docs

Repository files navigation

Sugar AI Docs

Built with Starlight

Docs for SugarAI Live

🚀 Project Structure

Inside of your Astro + Starlight project, you'll see the following folders and files:

.
├── public/
├── src/
│   ├── assets/
│   ├── content/
│   │   ├── docs/
│   │   └── config.ts
│   └── env.d.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json

Starlight looks for .md or .mdx files in the src/content/docs/ directory. Each file is exposed as a route based on its file name.

Images can be added to src/assets/ and embedded in Markdown with a relative link.

Static assets, like favicons, can be placed in the public/ directory.

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command Action
npm install Installs dependencies
npm run dev Starts local dev server at localhost:4321
npm run build Build your production site to ./dist/
npm run preview Preview your build locally, before deploying
npm run astro ... Run CLI commands like astro add, astro check
npm run astro -- --help Get help using the Astro CLI

Topcs

Get Started

  • Quick Start
  • Introduction
  • Architecture

Components

  • Voice To Action
  • Text to Action
  • Screen Embedding
  • Text API Interface

UI/UX Agents

  • Navigation Agent
  • Form Agent

Assistants - Voice Assistant - Text Assistant

Usecases

Deployment

  • Self hosting