Command line interface for accessing the Open Web Index shards and slices.

owi-cli docs source contributing index.md

1.1 kB · 56 lines

Markdown

Michael Granitzer · docs: add AI development infrastructure and documentation alignment · 10mo ago

Contributing to Owilix #

Welcome to the owilix developer documentation!

Quick Links #

Architecture - Project structure and core abstractions
Coding Guidelines - Coding standards and conventions
AI Development - Working with AI agents
Epics - Current work and backlog

Development Workflow #

We use a structured development process:

Epic → Feature Branch → Cycles → Phases → Tasks

See Epics for current work and backlog.

Getting Started #

Setup environment:
```
uv sync
```
Run tests:
```
uv run pytest tests/
```

Build docs:

cd docs
uv run sphinx-build -b html source/ build/html

Documentation Structure #

Location	Purpose
`docs/source/`	User-facing Sphinx docs
`docs/`	Developer/AI reference docs
`.agent/workflows/`	AI agent workflows

:hidden:
:maxdepth: 1

architecture
coding_guidelines
ai_development
epics