llama_deploy/docs/README.md

LlamaDeploy Documentation

This repository contains the documentation for LlamaDeploy, 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