Skip to content

feat: rewriting documentation to integrate to kotlinlang.org #3055

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

feat: rewriting documentation to integrate to kotlinlang.org #3055

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions docs-website/cfg/buildprofiles.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<?xml version="1.0" encoding="UTF-8"?>

<buildprofiles>
<variables>
<enable-browser-edits>true</enable-browser-edits>
<browser-edits-url>https://github.com/Kotlin/kotlinx.serialization/blob/master/docs/</browser-edits-url>
<allow-indexable-eaps>true</allow-indexable-eaps>
</variables>
<build-profile product="serialization"/>
</buildprofiles>
24 changes: 24 additions & 0 deletions docs-website/serialization.tree
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE instance-profile SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">
<instance-profile id="serialization" name="Serialization" start-page="serialization.md">
<snippet id="serialization">
<toc-element topic="serialization.md" toc-title="Introduction"/>
<toc-element toc-title="Get started">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think these elements are not directly related to the content of this PR; are you sure you will be able to keep them in sync during other PR's review process?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It shouldn't be a problem, it's just required for the WS preview/at the end for the library. At this point, it just serves as a skeleton, but we can modify it as we go with other PRs as needed.

<toc-element topic="serialization-get-started.md"/>
<toc-element topic="serialization-serialize-builtin-types.md"/>
<toc-element topic="serialization-customization-options.md"/>
</toc-element>
<toc-element toc-title="Configure JSON serialization">
<toc-element topic="configure-json-serialization.md" toc-title="Overview"/>
<toc-element topic="serialization-json-configuration.md"/>
<toc-element topic="serialization-json-elements.md"/>
<toc-element topic="serialization-transform-json.md" toc-title="JSON transformation"/>
</toc-element>
<toc-element topic="serialization-polymorphism.md"/>
<toc-element toc-title="Custom serializers">
<toc-element topic="create-custom-serializers.md"/>
<toc-element topic="third-party-classes.md"/>
</toc-element>
<toc-element topic="alternative-serialization-formats.md" toc-title="Alternative serialization formats"/>
</snippet>
</instance-profile>
7 changes: 7 additions & 0 deletions docs-website/v.list
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE vars SYSTEM "https://resources.jetbrains.com/stardust/vars.dtd">

<!-- Variables to be used throughout the documentation -->
<vars>

</vars>
15 changes: 15 additions & 0 deletions docs-website/writerside.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE ihp SYSTEM "https://resources.jetbrains.com/writerside/1.0/ihp.dtd">

<ihp version="2.0">
<module name="serialization"/>
<topics dir="topics"/>
<images dir="images"/>
<vars src="v.list"/> <!-- be careful with renaming the file, might lead to build errors / bugs -->
<settings>
<!-- ToC within topics, usually displayed on the left, depth is measured by header levels -->
<default-property element-name="chapter" property-name="show-structure-depth" value="2"/>
<wrs-supernova use-version="242.21870"/>
</settings>
<instance src="serialization.tree"/>
</ihp>