Skip to content

Add documentation on deriving type classes #850

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
samuel-1st wants to merge 5 commits into from
+680 −2
Closed

Add documentation on deriving type classes #850

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b634ba6
docs: add section on deriving type classes
samuel-1st Jan 26, 2026
ff47e69
Update key features and platform support details
samuel-1st Jan 26, 2026
7693783
Clarify TOON codec and caching behavior
samuel-1st Jan 26, 2026
e5e5c55
docs: clarify JSON deriver configuration wording
samuel-1st Jan 26, 2026
58599d8
docs: mark pretty printer as pseudo-code
samuel-1st Jan 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,10 @@ val msgpackCodec = Schema[Person].derive(MessagePackFormat.deriver) // MessagePa

### Key Features

- **Universal Data Formats**: JSON, Avro, TOON (compact LLM-optimized format), with Protobuf, Thrift, BSON, and MessagePack planned.
- **Universal Data Formats**: JSON, Avro, TOON (compact LLM-optimized format), Thrift, BSON, and MessagePack available today, with Protobuf planned.
- **High Performance**: Register-based design stores primitives directly in byte arrays, enabling zero-allocation serialization.
- **Reflective Optics**: Type-safe lenses, prisms, and traversals with embedded structural metadata.
- **Automatic Derivation**: Derive type class instances for any type with a schema.
- **Automatic Type-Class Derivation**: Derive codecs, validators, and custom type-classes for any type with a schema. See the [Type-Class Derivation guide](./reference/derivation.md) for details.

### Installation

Expand Down
Loading