# PyMLS Documentation

Welcome to the PyMLS documentation! This directory contains comprehensive documentation for the PyMLS library.

## Documentation Structure

### Getting Started
- **[Getting Started Guide](getting-started.md)** - Start here! Installation, basic concepts, and your first MLS group.

### API Documentation
- **[API Reference](api-reference.md)** - Complete API reference with detailed method documentation.

### Advanced Topics
- **[Advanced Features](advanced-features.md)** - External commits, PSKs, re-initialization, X.509 credentials, and more.

### Examples
- **[Examples](examples.md)** - Practical code examples for common use cases.

### Architecture
- **[Architecture](architecture.md)** - Internal architecture, component design, and implementation details.

## Quick Links

- **Installation**: See [Getting Started](getting-started.md#installation)
- **Basic Usage**: See [Getting Started](getting-started.md#your-first-mls-group)
- **API Reference**: See [API Reference](api-reference.md)
- **Advanced Features**: See [Advanced Features](advanced-features.md)

## Reading Order

1. **New to PyMLS?** Start with [Getting Started](getting-started.md)
2. **Need examples?** Check [Examples](examples.md)
3. **Looking for specific methods?** See [API Reference](api-reference.md)
4. **Want advanced features?** Read [Advanced Features](advanced-features.md)
5. **Understanding internals?** Explore [Architecture](architecture.md)

## Contributing

Found an error or want to improve the documentation? Contributions are welcome!

1. Check existing issues
2. Create a new issue or pull request
3. Follow the existing documentation style

## External Resources

- **RFC 9420**: [Messaging Layer Security](https://www.rfc-editor.org/rfc/rfc9420.html)
- **RFC 9180**: [HPKE: Hybrid Public Key Encryption](https://www.rfc-editor.org/rfc/rfc9180.html)
- **GitHub Repository**: [PyMLS on GitHub](https://github.com/yourusername/PyMLS)

## Support

- **Issues**: Report bugs or request features on GitHub
- **Questions**: Open a discussion on GitHub
- **Security**: Report security issues privately

---

**Note**: This documentation is for PyMLS version 0.3.1. For version-specific information, check the [main README](../README.md).

