Local Development¶

Quick guide for working with this repository.

Setup¶

Install the package with development dependencies:

uv sync --dev

Repository Structure¶

.
├── assets/dataset/           # Dataset files
│   ├── webarena-verified.json  # Working dataset
│   └── test.raw.json           # Original reference (read-only)
├── contributing/data/        # Dev tools for dataset management
│   ├── transforms/             # Transform scripts for bulk modifications
│   └── validators/             # Validation scripts for data integrity
├── docs/                     # Documentation source (MkDocs)
├── src/webarena_verified/    # Python package source code
│   └── types/                  # Type definitions and models
└── tasks.py                  # Invoke tasks for development

Working with Documentation¶

This documentation is built with MkDocs Material.

Serve Docs Locally¶

To start the development server with live reload:

uv run invoke -r contributing docs-serve # (1)

The command will print the URL to access the docs