update: first update for serialization documentation restructuring #2978
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pdvrieze
reviewed
Apr 10, 2025
docs/topics/serialization.md
Outdated
|
|
||
| ## Kotlin serialization libraries | ||
|
|
||
| The `kotlinx.serialization` library offers support for all platforms, including JVM, JavaScript, Native. |
There was a problem hiding this comment.
It may be worthwhile to clarify more that the serialization library provides the format agnostic infrastructure. Then the -json and -cbor libraries are format implementations (they are fundamentally different and are independent even though first-party).
sandwwraith
requested changes
Jul 18, 2025
pdvrieze
reviewed
Jul 20, 2025
daniCsorbaJB
force-pushed
the
doc-restructuring-updates-1
branch
from
4e69cdf to
85abee7
Compare
sandwwraith
reviewed
Aug 8, 2025
docs-website/topics/serialization.md
Outdated
| [//]: # (title: Serialization) | ||
|
|
||
| **Serialization** is the process of converting data used by an application to a format that can be transferred over a | ||
| network or stored in a database or a file. Deserialization is the opposite process of converting external data back into a runtime object. |
There was a problem hiding this comment.
Suggested change
| network or stored in a database or a file. Deserialization is the opposite process of converting external data back into a runtime object. | |
| network, or stored in a database or a file. Deserialization is the opposite process of converting external data back into a runtime object. |
docs-website/topics/serialization.md
Outdated
| network or stored in a database or a file. Deserialization is the opposite process of converting external data back into a runtime object. | ||
| Together, they are essential to most applications that exchange data with third parties. | ||
|
|
||
| Some data serialization formats, such as [JSON](https://www.json.org/json-en.html) and [Protocol Buffers](https://protobuf.dev/) are particularly common. |
There was a problem hiding this comment.
Suggested change
| Some data serialization formats, such as [JSON](https://www.json.org/json-en.html) and [Protocol Buffers](https://protobuf.dev/) are particularly common. | |
| Some data serialization formats, such as [JSON](https://www.json.org/json-en.html) and [Protocol Buffers](https://protobuf.dev/), are particularly common. |
docs-website/topics/serialization.md
Outdated
| Together, they are essential to most applications that exchange data with third parties. | ||
|
|
||
| Some data serialization formats, such as [JSON](https://www.json.org/json-en.html) and [Protocol Buffers](https://protobuf.dev/) are particularly common. | ||
| Being language-neutral and platform-neutral, these formats enable data exchange between systems written in any modern language. |
There was a problem hiding this comment.
Suggested change
| Being language-neutral and platform-neutral, these formats enable data exchange between systems written in any modern language. | |
| These formats are language- and platform-neutral, so you can use them to exchange data between systems written in any modern language. |
I think this reads more clearly if we talk about formats first. WDYT?
docs-website/topics/serialization.md
Outdated
|
|
||
| ## Kotlin serialization libraries | ||
|
|
||
| The `kotlinx.serialization` library offers support for all platforms, including JVM, JavaScript, Native. |
There was a problem hiding this comment.
Suggested change
| The `kotlinx.serialization` library offers support for all platforms, including JVM, JavaScript, Native. | |
| The `kotlinx.serialization` libraries offer support for all platforms, including the JVM, JavaScript, and Native platforms. |
docs-website/topics/serialization.md
Outdated
| * [Properties](https://en.wikipedia.org/wiki/.properties): [`kotlinx-serialization-properties`](https://github.com/Kotlin/kotlinx.serialization/blob/master/formats/README.md#properties) | ||
| * [HOCON](https://github.com/lightbend/config/blob/master/HOCON.md): [`kotlinx-serialization-hocon`](https://github.com/Kotlin/kotlinx.serialization/blob/master/formats/README.md#hocon) (only on JVM) | ||
|
|
||
| All libraries except JSON serialization (`kotlinx-serialization-json`) are [experimental](components-stability.md), which means their API can be changed without notice. |
There was a problem hiding this comment.
Suggested change
| All libraries except JSON serialization (`kotlinx-serialization-json`) are [experimental](components-stability.md), which means their API can be changed without notice. | |
| All libraries, except for JSON serialization (`kotlinx-serialization-json`), are [Experimental](components-stability.md). Their APIs might change at any time. |
docs-website/topics/serialization.md
Outdated
| ## What's next | ||
|
|
||
| * Learn the basics of Kotlin serialization in the [Get started with serialization tutorial](serialization-get-started.md). | ||
| * See how the `kotlinx.serialization` library processes [primitives, collections, and other built-in types](serialization-serialize-builtin-types.md) |
There was a problem hiding this comment.
Suggested change
| * See how the `kotlinx.serialization` library processes [primitives, collections, and other built-in types](serialization-serialize-builtin-types.md) | |
| * See how the `kotlinx.serialization` libraries process [primitives, collections, and other built-in types](serialization-serialize-builtin-types.md) |
docs-website/topics/serialization.md
Outdated
|
|
||
| * Learn the basics of Kotlin serialization in the [Get started with serialization tutorial](serialization-get-started.md). | ||
| * See how the `kotlinx.serialization` library processes [primitives, collections, and other built-in types](serialization-serialize-builtin-types.md) | ||
| * To explore more complex JSON serialization scenarios, see [JSON serialization overview](configure-json-serialization.md). |
There was a problem hiding this comment.
Suggested change
| * To explore more complex JSON serialization scenarios, see [JSON serialization overview](configure-json-serialization.md). | |
| * Explore more complex JSON serialization scenarios in the [JSON serialization overview](configure-json-serialization.md). |
docs-website/topics/serialization.md
Outdated
| * Learn the basics of Kotlin serialization in the [Get started with serialization tutorial](serialization-get-started.md). | ||
| * See how the `kotlinx.serialization` library processes [primitives, collections, and other built-in types](serialization-serialize-builtin-types.md) | ||
| * To explore more complex JSON serialization scenarios, see [JSON serialization overview](configure-json-serialization.md). | ||
| * Dive into the [Serialize classes](serialization-customization-options.md) section to learn how to serialize classes and how to modify the default behavior of the `@Serializable` annotation. |
There was a problem hiding this comment.
Suggested change
| * Dive into the [Serialize classes](serialization-customization-options.md) section to learn how to serialize classes and how to modify the default behavior of the `@Serializable` annotation. | |
| * Dive into [Serialize classes](serialization-customization-options.md) to learn how to serialize classes and modify the default behavior of the `@Serializable` annotation. |
sarahhaggarty
approved these changes
Aug 21, 2025
docs-website/topics/serialization.md
Outdated
Comment on lines
42
to
46
| | [JSON](https://www.json.org/json-en.html) | [`kotlinx-serialization-json`](https://github.com/Kotlin/kotlinx.serialization/blob/master/formats/README.md#json) | all supported platforms | Stable | | ||
| | [HOCON](https://github.com/lightbend/config/blob/master/HOCON.md) | [`kotlinx-serialization-hocon`](https://github.com/Kotlin/kotlinx.serialization/blob/master/formats/README.md#hocon) | JVM only | Experimental | | ||
| | [Protocol Buffers](https://protobuf.dev/) | [`kotlinx-serialization-protobuf`](https://github.com/Kotlin/kotlinx.serialization/blob/master/formats/README.md#protobuf) | all supported platforms | Experimental | | ||
| | [CBOR](https://cbor.io/) | [`kotlinx-serialization-cbor`](https://github.com/Kotlin/kotlinx.serialization/blob/master/formats/README.md#cbor) | all supported platforms | Experimental | | ||
| | [Properties](https://en.wikipedia.org/wiki/.properties) | [`kotlinx-serialization-properties`](https://github.com/Kotlin/kotlinx.serialization/blob/master/formats/README.md#properties) | all supported platforms | Experimental | |
There was a problem hiding this comment.
Suggested change
| | [JSON](https://www.json.org/json-en.html) | [`kotlinx-serialization-json`](https://github.com/Kotlin/kotlinx.serialization/blob/master/formats/README.md#json) | all supported platforms | Stable | | |
| | [HOCON](https://github.com/lightbend/config/blob/master/HOCON.md) | [`kotlinx-serialization-hocon`](https://github.com/Kotlin/kotlinx.serialization/blob/master/formats/README.md#hocon) | JVM only | Experimental | | |
| | [Protocol Buffers](https://protobuf.dev/) | [`kotlinx-serialization-protobuf`](https://github.com/Kotlin/kotlinx.serialization/blob/master/formats/README.md#protobuf) | all supported platforms | Experimental | | |
| | [CBOR](https://cbor.io/) | [`kotlinx-serialization-cbor`](https://github.com/Kotlin/kotlinx.serialization/blob/master/formats/README.md#cbor) | all supported platforms | Experimental | | |
| | [Properties](https://en.wikipedia.org/wiki/.properties) | [`kotlinx-serialization-properties`](https://github.com/Kotlin/kotlinx.serialization/blob/master/formats/README.md#properties) | all supported platforms | Experimental | | |
| | [JSON](https://www.json.org/json-en.html) | [`kotlinx-serialization-json`](https://github.com/Kotlin/kotlinx.serialization/blob/master/formats/README.md#json) | All supported platforms | Stable | | |
| | [HOCON](https://github.com/lightbend/config/blob/master/HOCON.md) | [`kotlinx-serialization-hocon`](https://github.com/Kotlin/kotlinx.serialization/blob/master/formats/README.md#hocon) | JVM only | Experimental | | |
| | [Protocol Buffers](https://protobuf.dev/) | [`kotlinx-serialization-protobuf`](https://github.com/Kotlin/kotlinx.serialization/blob/master/formats/README.md#protobuf) | All supported platforms | Experimental | | |
| | [CBOR](https://cbor.io/) | [`kotlinx-serialization-cbor`](https://github.com/Kotlin/kotlinx.serialization/blob/master/formats/README.md#cbor) | All supported platforms | Experimental | | |
| | [Properties](https://en.wikipedia.org/wiki/.properties) | [`kotlinx-serialization-properties`](https://github.com/Kotlin/kotlinx.serialization/blob/master/formats/README.md#properties) | All supported platforms | Experimental | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is for the first batch of documentation updates for KT-79623 [Docs][Libraries] Serialization introduction