# create3_docs

**Repository Path**: robotization/create3_docs

## Basic Information

- **Project Name**: create3_docs
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: Rebecca-iRobot-QA-form
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-07-22
- **Last Updated**: 2025-07-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# create3_docs

This repository contains the source code for the iRobot® Create® 3 Educational Robot documentation.
The automatically generated website can be viewed at https://iroboteducation.github.io/create3_docs/

### Build the docs locally

Install required dependencies:

```bash
pip3 install mkdocs
pip3 install mkdocs-material
pip3 install -r requirements.txt
```

Optionally, if you desire to generate images of STL models dynamically install:

```bash
pip3 install -r model_image_generation.txt
```


Build the documentation locally:

```bash
mkdocs serve
```

Open `http://127.0.0.1:8000/` in a browser to visualize the docs.

### Updating the docs

After commits are pushed to the `main` branch a new build of the website will automatically start.