From 3638eca732120be9267031b06ff3de32531dd654 Mon Sep 17 00:00:00 2001 From: Daniel Csorba Date: Thu, 10 Apr 2025 14:59:36 +0200 Subject: [PATCH 1/7] update: first update for serialization documentation restructuring --- docs/cfg/buildprofiles.xml | 10 +++++ docs/images/serialization.svg | 13 ++++++ docs/serialization.tree | 24 +++++++++++ docs/topics/serialization.md | 78 +++++++++++++++++++++++++++++++++++ docs/v.list | 7 ++++ docs/writerside.cfg | 15 +++++++ 6 files changed, 147 insertions(+) create mode 100644 docs/cfg/buildprofiles.xml create mode 100644 docs/images/serialization.svg create mode 100644 docs/serialization.tree create mode 100644 docs/topics/serialization.md create mode 100644 docs/v.list create mode 100644 docs/writerside.cfg diff --git a/docs/cfg/buildprofiles.xml b/docs/cfg/buildprofiles.xml new file mode 100644 index 0000000000..d2b2e970b6 --- /dev/null +++ b/docs/cfg/buildprofiles.xml @@ -0,0 +1,10 @@ + + + + + true + https://github.com/Kotlin/kotlinx.serialization/blob/master/docs/ + true + + + diff --git a/docs/images/serialization.svg b/docs/images/serialization.svg new file mode 100644 index 0000000000..af03236c64 --- /dev/null +++ b/docs/images/serialization.svg @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/serialization.tree b/docs/serialization.tree new file mode 100644 index 0000000000..785272791a --- /dev/null +++ b/docs/serialization.tree @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/topics/serialization.md b/docs/topics/serialization.md new file mode 100644 index 0000000000..5188e6d705 --- /dev/null +++ b/docs/topics/serialization.md @@ -0,0 +1,78 @@ +[//]: # (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. +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. + +To convert an object tree to a string or to a sequence of bytes, it must go through two mutually intertwined processes: + +1. Serialization: Objects are transformed into a sequence of their primitive values. +This universal process varies depending on the object and is managed by a serializer. +2. Encoding: The primitive sequence is converted into the desired output format, controlled by an encoder. + +![Serialization flow](serialization.svg){width=700} + +The reverse process involves parsing the input format, decoding the primitive values, and then deserializing the resulting +stream into objects. + +If you're new to serialization in Kotlin, we recommend starting with the [Get Started with Serialization](serialization-get-started.md) guide. +This section provides a step-by-step guide to help you set up and use Kotlin serialization in your projects. +By following these steps, you can quickly get up to speed with the basics before diving into more complex topics. + +## Kotlin serialization libraries + +The `kotlinx.serialization` library offers support for all platforms, including JVM, JavaScript, Native. +It works with various serialization formats, such as JSON, CBOR, and Protocol buffers. For the complete list of supported serialization, +see the [supported formats](#supported-serialization-formats) section. + +All Kotlin serialization libraries are part of the `org.jetbrains.kotlinx:` group, with names +starting with `kotlinx-serialization-` and suffixes that reflect the serialization format. +For example: + +* `org.jetbrains.kotlinx:kotlinx-serialization-json` provides JSON serialization for Kotlin projects. +* `org.jetbrains.kotlinx:kotlinx-serialization-cbor` provides CBOR serialization. + +Platform-specific dependencies are automatically managed, so you don’t need to add them manually. +Use the same dependencies for JVM, JavaScript, Native, and multiplatform projects. + +The `kotlinx.serialization` libraries follow their own versioning structure, independent of Kotlin. +You can check out the releases on [GitHub](https://github.com/Kotlin/kotlinx.serialization/releases) to find the latest versions. + +## Supported serialization formats + +`kotlinx.serialization` includes libraries for various serialization formats: + +* [JSON](https://www.json.org/json-en.html): [`kotlinx-serialization-json`](https://github.com/Kotlin/kotlinx.serialization/blob/master/formats/README.md#json) +* [Protocol buffers](https://protobuf.dev/): [`kotlinx-serialization-protobuf`](https://github.com/Kotlin/kotlinx.serialization/blob/master/formats/README.md#protobuf) +* [CBOR](https://cbor.io/): [`kotlinx-serialization-cbor`](https://github.com/Kotlin/kotlinx.serialization/blob/master/formats/README.md#cbor) +* [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. +For more details about JSON serialization, see [JSON serialization overview](configure-json-serialization.md). + +There are also community-maintained libraries that support more serialization formats, such as [YAML](https://yaml.org/) or [Apache Avro](https://avro.apache.org/). + +You can find out more about experimental serialization formats in [Alternative and custom serialization formats](alternative-serialization-formats.md). + +## Supported serialization types + +Kotlin serialization supports a variety of built-in types, including all primitive types and composite types from the Kotlin standard library like the `List` type. +For more information, see [Serialize built-in types](serialization-serialize-builtin-types.md). + +> Not all types from the Kotlin standard library are serializable. In particular, [ranges](ranges.md) and the [`Regex`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/-regex/) class are not serializable at the moment. +> Support for their serialization may be added in the future. +> +{style="note"} + +Additionally, classes annotated with `@Serializable` are fully supported for serialization, enabling the conversion of class instances to and from formats like JSON. +For more information, see [Serialize classes](serialization-customization-options.md). + +## What's next + +* Learn the basics of Kotlin serialization in the [Get started with serialization guide](serialization-get-started.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. diff --git a/docs/v.list b/docs/v.list new file mode 100644 index 0000000000..a30391bf1e --- /dev/null +++ b/docs/v.list @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/writerside.cfg b/docs/writerside.cfg new file mode 100644 index 0000000000..a011270f4d --- /dev/null +++ b/docs/writerside.cfg @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + From c255e0d9986208704d6d4fecaf16c4d61533b57d Mon Sep 17 00:00:00 2001 From: Daniel Csorba Date: Tue, 29 Jul 2025 17:01:15 +0200 Subject: [PATCH 2/7] implementing review comments --- docs/images/get-started-serialization.svg | 5 +++++ docs/topics/serialization.md | 22 ++++++++-------------- 2 files changed, 13 insertions(+), 14 deletions(-) create mode 100644 docs/images/get-started-serialization.svg diff --git a/docs/images/get-started-serialization.svg b/docs/images/get-started-serialization.svg new file mode 100644 index 0000000000..482ca3bebd --- /dev/null +++ b/docs/images/get-started-serialization.svg @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/topics/serialization.md b/docs/topics/serialization.md index 5188e6d705..efae14a678 100644 --- a/docs/topics/serialization.md +++ b/docs/topics/serialization.md @@ -6,21 +6,13 @@ Together, they are essential to most applications that exchange data with third 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. +Kotlin provides this functionality through the [`kotlinx.serialization` libraries](#kotlin-serialization-libraries), +which support multiple platforms and data formats. -To convert an object tree to a string or to a sequence of bytes, it must go through two mutually intertwined processes: +If you're new to serialization in Kotlin, we recommend starting with the [Get Started with Serialization](serialization-get-started.md) tutorial. +It provides a step-by-step guide to help you set up and use Kotlin serialization in your project. -1. Serialization: Objects are transformed into a sequence of their primitive values. -This universal process varies depending on the object and is managed by a serializer. -2. Encoding: The primitive sequence is converted into the desired output format, controlled by an encoder. - -![Serialization flow](serialization.svg){width=700} - -The reverse process involves parsing the input format, decoding the primitive values, and then deserializing the resulting -stream into objects. - -If you're new to serialization in Kotlin, we recommend starting with the [Get Started with Serialization](serialization-get-started.md) guide. -This section provides a step-by-step guide to help you set up and use Kotlin serialization in your projects. -By following these steps, you can quickly get up to speed with the basics before diving into more complex topics. +Get started with serialization ## Kotlin serialization libraries @@ -73,6 +65,8 @@ For more information, see [Serialize classes](serialization-customization-option ## What's next -* Learn the basics of Kotlin serialization in the [Get started with serialization guide](serialization-get-started.md). +* 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-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. +* Learn how to define and customize your own serializers in [Create custom serializers](serialization-custom-serializers.md). From 85abee715ca209e6b7ab5d238499edf27d73b904 Mon Sep 17 00:00:00 2001 From: Daniel Csorba Date: Thu, 31 Jul 2025 17:35:28 +0200 Subject: [PATCH 3/7] setting up temporary folder for review --- .../images/get-started-serialization.svg | 0 .../images/serialization.svg | 0 .../topics/serialization.md | 2 +- docs/cfg/buildprofiles.xml | 10 -------- docs/serialization.tree | 24 ------------------- docs/v.list | 7 ------ docs/writerside.cfg | 15 ------------ 7 files changed, 1 insertion(+), 57 deletions(-) rename {docs => docs-website}/images/get-started-serialization.svg (100%) rename {docs => docs-website}/images/serialization.svg (100%) rename {docs => docs-website}/topics/serialization.md (97%) delete mode 100644 docs/cfg/buildprofiles.xml delete mode 100644 docs/serialization.tree delete mode 100644 docs/v.list delete mode 100644 docs/writerside.cfg diff --git a/docs/images/get-started-serialization.svg b/docs-website/images/get-started-serialization.svg similarity index 100% rename from docs/images/get-started-serialization.svg rename to docs-website/images/get-started-serialization.svg diff --git a/docs/images/serialization.svg b/docs-website/images/serialization.svg similarity index 100% rename from docs/images/serialization.svg rename to docs-website/images/serialization.svg diff --git a/docs/topics/serialization.md b/docs-website/topics/serialization.md similarity index 97% rename from docs/topics/serialization.md rename to docs-website/topics/serialization.md index efae14a678..13b0d35344 100644 --- a/docs/topics/serialization.md +++ b/docs-website/topics/serialization.md @@ -10,7 +10,7 @@ Kotlin provides this functionality through the [`kotlinx.serialization` librarie which support multiple platforms and data formats. If you're new to serialization in Kotlin, we recommend starting with the [Get Started with Serialization](serialization-get-started.md) tutorial. -It provides a step-by-step guide to help you set up and use Kotlin serialization in your project. +It walks you through adding the Kotlin serialization library to your project and shows you how to serialize and deserialize your first class. Get started with serialization diff --git a/docs/cfg/buildprofiles.xml b/docs/cfg/buildprofiles.xml deleted file mode 100644 index d2b2e970b6..0000000000 --- a/docs/cfg/buildprofiles.xml +++ /dev/null @@ -1,10 +0,0 @@ - - - - - true - https://github.com/Kotlin/kotlinx.serialization/blob/master/docs/ - true - - - diff --git a/docs/serialization.tree b/docs/serialization.tree deleted file mode 100644 index 785272791a..0000000000 --- a/docs/serialization.tree +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/v.list b/docs/v.list deleted file mode 100644 index a30391bf1e..0000000000 --- a/docs/v.list +++ /dev/null @@ -1,7 +0,0 @@ - - - - - - - diff --git a/docs/writerside.cfg b/docs/writerside.cfg deleted file mode 100644 index a011270f4d..0000000000 --- a/docs/writerside.cfg +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - - - - - - - - - - From f1412c72ffb00e2d1585d5f5900751c27a12f748 Mon Sep 17 00:00:00 2001 From: Daniel Csorba Date: Mon, 11 Aug 2025 09:45:55 +0200 Subject: [PATCH 4/7] implementing review comments --- docs-website/images/serialization.svg | 13 ------------- docs-website/topics/serialization.md | 10 +++------- 2 files changed, 3 insertions(+), 20 deletions(-) delete mode 100644 docs-website/images/serialization.svg diff --git a/docs-website/images/serialization.svg b/docs-website/images/serialization.svg deleted file mode 100644 index af03236c64..0000000000 --- a/docs-website/images/serialization.svg +++ /dev/null @@ -1,13 +0,0 @@ - - - - - - - - - - - - - diff --git a/docs-website/topics/serialization.md b/docs-website/topics/serialization.md index 13b0d35344..5ef8c163ab 100644 --- a/docs-website/topics/serialization.md +++ b/docs-website/topics/serialization.md @@ -52,21 +52,17 @@ You can find out more about experimental serialization formats in [Alternative a ## Supported serialization types -Kotlin serialization supports a variety of built-in types, including all primitive types and composite types from the Kotlin standard library like the `List` type. +Kotlin serialization supports a variety of built-in types, including all primitive types and most composite types from the Kotlin standard library like the `List` type. For more information, see [Serialize built-in types](serialization-serialize-builtin-types.md). -> Not all types from the Kotlin standard library are serializable. In particular, [ranges](ranges.md) and the [`Regex`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/-regex/) class are not serializable at the moment. -> Support for their serialization may be added in the future. -> -{style="note"} - Additionally, classes annotated with `@Serializable` are fully supported for serialization, enabling the conversion of class instances to and from formats like JSON. For more information, see [Serialize classes](serialization-customization-options.md). ## 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-builtin-types.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. * Learn how to define and customize your own serializers in [Create custom serializers](serialization-custom-serializers.md). +* See how to serialize different types through a shared base type in [Serialize polymorphic classes](serialization-polymorphism.md). \ No newline at end of file From 7f6e189209450ad4f9c320f47bef89547bc819e4 Mon Sep 17 00:00:00 2001 From: Daniel Csorba Date: Mon, 11 Aug 2025 13:18:35 +0200 Subject: [PATCH 5/7] fix: typo --- docs-website/topics/serialization.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-website/topics/serialization.md b/docs-website/topics/serialization.md index 5ef8c163ab..825cc784df 100644 --- a/docs-website/topics/serialization.md +++ b/docs-website/topics/serialization.md @@ -27,7 +27,7 @@ For example: * `org.jetbrains.kotlinx:kotlinx-serialization-json` provides JSON serialization for Kotlin projects. * `org.jetbrains.kotlinx:kotlinx-serialization-cbor` provides CBOR serialization. -Platform-specific dependencies are automatically managed, so you don’t need to add them manually. +Platform-specific dependencies are automatically managed, so you don't need to add them manually. Use the same dependencies for JVM, JavaScript, Native, and multiplatform projects. The `kotlinx.serialization` libraries follow their own versioning structure, independent of Kotlin. From 6e255516d3a565086e24ecb9d692b5e81b98b902 Mon Sep 17 00:00:00 2001 From: Daniel Csorba Date: Tue, 19 Aug 2025 09:22:14 +0200 Subject: [PATCH 6/7] implementing TWr review comments --- docs-website/topics/serialization.md | 44 +++++++++++++++------------- 1 file changed, 23 insertions(+), 21 deletions(-) diff --git a/docs-website/topics/serialization.md b/docs-website/topics/serialization.md index 825cc784df..109c440905 100644 --- a/docs-website/topics/serialization.md +++ b/docs-website/topics/serialization.md @@ -1,11 +1,11 @@ [//]: # (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. +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. -Being language-neutral and platform-neutral, these formats enable data exchange between systems written in any modern language. +Some data serialization formats, such as [JSON](https://www.json.org/json-en.html) and [Protocol Buffers](https://protobuf.dev/), are particularly common. +These formats are language-neutral and platform-neutral, so you can use them to exchange data between systems written in any modern language. Kotlin provides this functionality through the [`kotlinx.serialization` libraries](#kotlin-serialization-libraries), which support multiple platforms and data formats. @@ -16,34 +16,36 @@ It walks you through adding the Kotlin serialization library to your project and ## Kotlin serialization libraries -The `kotlinx.serialization` library offers support for all platforms, including JVM, JavaScript, Native. -It works with various serialization formats, such as JSON, CBOR, and Protocol buffers. For the complete list of supported serialization, -see the [supported formats](#supported-serialization-formats) section. +Kotlin serialization offers support for all platforms, including JVM, JavaScript, and Native. +You can use the same [dependency declaration](serialization-get-started.md#add-plugins-and-dependencies-for-kotlin-serialization) regardless of the target platform. + +Kotlin serialization supports various serialization formats, such as JSON, CBOR, and Protocol buffers through different serialization format libraries. +These libraries build on the core `kotlinx.serialization` library. +For the complete list of supported serialization formats, see [Supported serialization formats](#supported-serialization-formats). All Kotlin serialization libraries are part of the `org.jetbrains.kotlinx:` group, with names starting with `kotlinx-serialization-` and suffixes that reflect the serialization format. For example: -* `org.jetbrains.kotlinx:kotlinx-serialization-json` provides JSON serialization for Kotlin projects. +* `org.jetbrains.kotlinx:kotlinx-serialization-json` provides JSON serialization. * `org.jetbrains.kotlinx:kotlinx-serialization-cbor` provides CBOR serialization. -Platform-specific dependencies are automatically managed, so you don't need to add them manually. -Use the same dependencies for JVM, JavaScript, Native, and multiplatform projects. - -The `kotlinx.serialization` libraries follow their own versioning structure, independent of Kotlin. -You can check out the releases on [GitHub](https://github.com/Kotlin/kotlinx.serialization/releases) to find the latest versions. +The `kotlinx.serialization` libraries follow their own versioning, independent of Kotlin. +You can find the latest release versions on [GitHub](https://github.com/Kotlin/kotlinx.serialization/releases). ## Supported serialization formats -`kotlinx.serialization` includes libraries for various serialization formats: +`kotlinx.serialization` includes serialization format libraries for various formats: -* [JSON](https://www.json.org/json-en.html): [`kotlinx-serialization-json`](https://github.com/Kotlin/kotlinx.serialization/blob/master/formats/README.md#json) -* [Protocol buffers](https://protobuf.dev/): [`kotlinx-serialization-protobuf`](https://github.com/Kotlin/kotlinx.serialization/blob/master/formats/README.md#protobuf) -* [CBOR](https://cbor.io/): [`kotlinx-serialization-cbor`](https://github.com/Kotlin/kotlinx.serialization/blob/master/formats/README.md#cbor) -* [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) +| Format | Artifact ID | Platform | Status | +|--------------|--------------------------------------------------------------------------------------------------------------------------------|-------------------------|--------------| +| [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 | -All libraries except JSON serialization (`kotlinx-serialization-json`) are [experimental](components-stability.md), which means their API can be changed without notice. +All serialization format libraries, except for the JSON serialization library (`kotlinx-serialization-json`), are [Experimental](components-stability.md). Their APIs might change at any time. For more details about JSON serialization, see [JSON serialization overview](configure-json-serialization.md). There are also community-maintained libraries that support more serialization formats, such as [YAML](https://yaml.org/) or [Apache Avro](https://avro.apache.org/). @@ -62,7 +64,7 @@ For more information, see [Serialize classes](serialization-customization-option * 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. +* Explore more complex JSON serialization scenarios in the [JSON serialization overview](configure-json-serialization.md). +* Dive into [Serialize classes](serialization-customization-options.md) to learn how to serialize classes and modify the default behavior of the `@Serializable` annotation. * Learn how to define and customize your own serializers in [Create custom serializers](serialization-custom-serializers.md). * See how to serialize different types through a shared base type in [Serialize polymorphic classes](serialization-polymorphism.md). \ No newline at end of file From 411a27475fc07cb42ceb89b82eb330605eaff462 Mon Sep 17 00:00:00 2001 From: Daniel Csorba Date: Thu, 21 Aug 2025 10:11:06 +0200 Subject: [PATCH 7/7] implementing last TWr review comments --- docs-website/topics/serialization.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs-website/topics/serialization.md b/docs-website/topics/serialization.md index 109c440905..66a82dc748 100644 --- a/docs-website/topics/serialization.md +++ b/docs-website/topics/serialization.md @@ -23,7 +23,7 @@ Kotlin serialization supports various serialization formats, such as JSON, CBOR, These libraries build on the core `kotlinx.serialization` library. For the complete list of supported serialization formats, see [Supported serialization formats](#supported-serialization-formats). -All Kotlin serialization libraries are part of the `org.jetbrains.kotlinx:` group, with names +All Kotlin serialization format libraries are part of the `org.jetbrains.kotlinx:` group, with names starting with `kotlinx-serialization-` and suffixes that reflect the serialization format. For example: @@ -63,7 +63,7 @@ For more information, see [Serialize classes](serialization-customization-option ## 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) +* See how the Kotlin serialization library processes [primitives, collections, and other built-in types](serialization-serialize-builtin-types.md) * Explore more complex JSON serialization scenarios in the [JSON serialization overview](configure-json-serialization.md). * Dive into [Serialize classes](serialization-customization-options.md) to learn how to serialize classes and modify the default behavior of the `@Serializable` annotation. * Learn how to define and customize your own serializers in [Create custom serializers](serialization-custom-serializers.md).