# go-yaml Documentation

## User Guides

| Document | Description |
|----------|-------------|
| [v3 to v4 Migration](v3-to-v4-migration.md) | Complete guide for upgrading from v3 |
| [Options Reference](options.md) | All configuration options explained |

## Developer Documentation

For contributors and those interested in go-yaml internals:

- **[dev/](dev/)** — Internal documentation directory
  - [go-yaml Internals](dev/go-yaml-internals.md) — Comprehensive analysis of
    load/dump stacks, stages, transforms, and architectural issues
  - [How go-yaml Works](dev/how-go-yaml-works.md) — High-level overview of
    YAML processing
  - [Dump and Load API](dev/dump-load-api.md) — Comprehensive API guide
  - [Mermaid Diagrams](dev/) — Pipeline overview, call hierarchy, comment
    flow, and resolver problem diagrams

## Quick Links

- [Main README](../README.md) — Getting started
- [CONTRIBUTING](../CONTRIBUTING.md) — How to contribute
- [Examples](../example/README.md) — Runnable code examples
- [API Reference](https://pkg.go.dev/go.yaml.in/yaml/v4) — Full API
  documentation
