Files
workflows-py/docs/api_docs/README.md
T
Laurie Voss 8847b41d38 Migrate main docs to Astro (#122)
* Migrate main docs to Astro

* Migrate mkdocs.yml to stripped-down form

* Move up one level

* Static should maybe be elsewhere

* Linting
2025-10-02 13:34:30 -07:00

1.0 KiB

LlamaDeploy Documentation

This repository contains the documentation for LlamaIndex Workflows, built using MkDocs with Material theme.

Setup

Prerequisites

  • Python 3.10 or higher
  • uv (for dependency management)

Installation

  1. Clone the repository
  2. Install dependencies using uv:
uv sync

Development

To start the documentation server locally:

uv run mkdocs serve

This will start a development server at http://127.0.0.1:8000.

Building

LlamaDeploy is part of LlamaIndex documentation portal so the build is performed from the main repository.

Warning

When a documentation change is merged here, the change won't be visible until a new build is triggered from the LlamaIndex repository.

Contributing

Contributions are very welcome!

  1. Create a new branch for your changes
  2. Make your changes to the documentation
  3. Test locally using uv run mkdocs serve
  4. Submit a pull request