diff options
author | Roman Elizarov <elizarov@gmail.com> | 2020-08-11 12:27:36 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-08-11 12:27:36 +0300 |
commit | 5459c10508d8d354098e6422499d0e8b9f453d70 (patch) | |
tree | 05949893d311f8ba6bfacdb08a8570f57357a8b4 /knit.properties | |
parent | 65fdbc7d8ac24c96110a6b1230f7a361e5e145bc (diff) | |
download | kotlinx.serialization-5459c10508d8d354098e6422499d0e8b9f453d70.tar.gz |
Docs: Kotlin Serialization Guide (#933)
Documentation from the docs folder is incorporated into a common story that spans six chapters and proceeds from the basic serialization to the experimental alternative and custom formats. The example files are automatically generated from the text with the Knit tool (guide/example folder) and are verified with the automatically generated tests (guide/test folder).
The entry point to the new is docs/serialization-guide.md that contains the overall table of contents and links to the specific chapters.
The old docs that are being incorporated:
* cbor_byte_string.md -> formats.md
* custom_serializers.md -> serializers.md
* examples.md -> basic-serialization.md
* json_transformations.md -> json.md
* old12.md (removed completely as obsolete)
* runtime_usage.md -> various chapters
Additional changes include:
* Top-level README.md file is cleaned up from legacy information and also contains a modern knitted example.
* More consistent error messages in various exceptions.
* Minor corrections to KDocs and APIs.
* Better style.css for the documentation that is generated by Dokka.
* Improved update_docs.sh to put temporary files inside the build folder.
Co-authored-by: Vsevolod Tolstopyatov <qwwdfsad@gmail.com>
Diffstat (limited to 'knit.properties')
-rw-r--r-- | knit.properties | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/knit.properties b/knit.properties new file mode 100644 index 00000000..9cfed61a --- /dev/null +++ b/knit.properties @@ -0,0 +1,5 @@ +knit.dir=guide/example/ +knit.package=example + +test.dir=guide/test/ +test.package=example.test |