# Katana OpenAPI Client Documentation

This directory contains all documentation specific to the `katana-openapi-client`
package.

## Documentation Index

### User Guides

- **[Client Guide](guide.md)** - Comprehensive guide to using the Katana OpenAPI Client
- **[Cookbook](cookbook.md)** - Common usage patterns and recipes
- **[Testing Guide](testing.md)** - Testing strategy and test coverage

### Maintainer Guides

- **[OpenAPI Spec Authoring](spec-authoring.md)** - OpenAPI 3.1 conventions,
  generator/regen lockstep, `ListResponse` shape, breaking-change markers, privacy
  rules. Read this before editing `docs/katana-openapi.yaml`.

### Reference

- **[Changelog](CHANGELOG.md)** - Release history and version notes
- **[ADRs](adr/README.md)** - Architecture Decision Records

## Quick Links

- **[Main Repository README](../../README.md)** - Project overview
- **[Contributing Guide](../../docs/CONTRIBUTING.md)** - How to contribute
- **[API Documentation](https://dougborg.github.io/katana-openapi-client/)** - Live docs
  site

## Related Packages

This monorepo also contains:

- **[katana-mcp-server](../../katana_mcp_server/docs/README.md)** - MCP server for
  Claude Code integration
