# Documentation Reference

Quick-lookup guides for OpenAPI patterns, Mermaid diagrams, and documentation quality standards.

## Available References

### [OpenAPI 3.1 Patterns](openapi-patterns.md)

Comprehensive OpenAPI 3.1 specification patterns for Grey Haven stack.

**Covers**: Complete schemas, authentication (JWT/OAuth2/API Key), error responses, pagination, multi-language examples, webhooks, FastAPI integration

**Use for**: API documentation generation, OpenAPI schema creation, endpoint documentation standards

---

### [Mermaid Diagram Templates](mermaid-diagrams.md)

Complete templates for all Mermaid diagram types with Grey Haven examples.

**Covers**: System architecture, sequence diagrams, data flow, ER diagrams, state machines, deployment diagrams, class diagrams

**Use for**: Architecture documentation, visualizing data flows, documenting state transitions, database schemas

---

### [Documentation Standards](documentation-standards.md)

Quality standards and best practices for technical documentation.

**Covers**: Writing style, code examples, API documentation templates, function documentation (JSDoc/docstrings), README structure, quality checklist

**Use for**: Ensuring consistency, setting quality thresholds, creating maintainable documentation

---

## Common Patterns

1. **API Documentation**: Use OpenAPI patterns + documentation standards
2. **Architecture Docs**: Use Mermaid diagrams + ADR template from standards
3. **Coverage Validation**: Use standards checklist + automated tools

## Quick Reference

| Need | Reference | Key Section |
|------|-----------|-------------|
| API endpoint docs | [openapi-patterns.md](openapi-patterns.md) | Endpoint Documentation Template |
| System diagrams | [mermaid-diagrams.md](mermaid-diagrams.md) | Architecture Diagrams |
| Quality checklist | [documentation-standards.md](documentation-standards.md) | Quality Checklist |
| Code examples | [documentation-standards.md](documentation-standards.md) | Code Examples |
| Error responses | [openapi-patterns.md](openapi-patterns.md) | Error Response Schema |

---

Related: [Examples](../examples/INDEX.md) | [Templates](../templates/) | [Return to Agent](../docs-architect.md)