Writerside (#68)

* Basic writerside setup

* Move GETTING_STARTED.md to writerside (1/2)

* Move GETTING_STARTED.md to writerside (2/2)

* update project name

* Updated configs

* Updated getting started guide

* updated copyrights

.github/workflows/build-docs.yml

@@ -0,0 +1,83 @@
+name: Build documentation
+
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+permissions:
+  id-token: write
+  pages: write
+
+env:
+  INSTANCE: 'Writerside/rpc'
+  ARTIFACT: 'webHelpRPC2-all.zip'
+  DOCKER_VERSION: '241.15989'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Build docs using Writerside Docker builder
+        uses: JetBrains/writerside-github-action@v4
+        with:
+          instance: ${{ env.INSTANCE }}
+          artifact: ${{ env.ARTIFACT }}
+          docker-version: ${{ env.DOCKER_VERSION }}
+          locations: docs/pages/Writerside/
+
+      - name: Save artifact with build results
+        uses: actions/upload-artifact@v4
+        with:
+          name: kotlinx-rpc
+          path: |
+            artifacts/${{ env.ARTIFACT }}
+            artifacts/report.json
+          retention-days: 7
+
+  test:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: kotlinx-rpc
+          path: artifacts
+
+      - name: Test documentation
+        uses: JetBrains/writerside-checker-action@v1
+        with:
+          instance: ${{ env.INSTANCE }}
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: [ build, test ]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: kotlinx-rpc
+
+      - name: Unzip artifact
+        run: unzip -O UTF-8 -qq '${{ env.ARTIFACT }}' -d dir
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Package and upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: dir
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -76,7 +76,7 @@ streamScoped {
 }
 ```
 
-Check out our [getting started guide](GETTING_STARTED.md) for a thorough overview of all components and features.
+Check out our [getting started guide](https://kotlin.github.io/kotlinx-rpc) for a thorough overview of all components and features.
 
 ## Configure the project
 

docs/pages/kotlinx-rpc/RPC.tree

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  - Copyright 2023-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+  -->
+
+<!DOCTYPE instance-profile
+        SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">
+
+<instance-profile id="RPC"
+                 name="kotlinx.rpc"
+                 start-page="getting_started.md">
+
+    <toc-element topic="getting_started.md"/>
+</instance-profile>

docs/pages/kotlinx-rpc/c.list

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  - Copyright 2023-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+  -->
+
+<!DOCTYPE categories
+        SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
+<categories/>

docs/pages/kotlinx-rpc/cfg/buildprofiles.xml

@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Copyright 2023-2024 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
+  -->
+
+<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
+               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+
+    <variables>
+        <website-title>%instance% Documentation</website-title>
+        <web-root>%host%</web-root>
+        <product-web-url>%repo-root-path%</product-web-url>
+
+        <primary-color>purple</primary-color>
+        <header-logo>logo.svg</header-logo>
+        <custom-favicons>icon16.png,icon32.png,icon96.png,icon300.png,icon500.png</custom-favicons>
+
+        <browser-edits-url>%docs-edit-path%/</browser-edits-url>
+        <enable-browser-edits>true</enable-browser-edits>
+
+        <og-image>%docs-raw-path%/preview.png</og-image>
+
+        <versions-switcher>%host%/kotlinx-rpc/help-versions.json</versions-switcher>
+
+        <generate-sitemap-url-prefix>https://www.jetbrains.com/help/</generate-sitemap-url-prefix>
+    </variables>
+
+    <build-profile instance="RPC">
+        <variables>
+            <noindex-content>false</noindex-content>
+        </variables>
+    </build-profile>
+
+    <sitemap priority="0.35" change-frequency="monthly"/>
+    <footer>
+        <copyright>2000-2024 JetBrains s.r.o.</copyright>
+        <link href="https://github.com/Koltin/kotlinx-rpc/blob/main/CONTRIBUTING.md">Contribute to kotlinx.rpc</link>
+        <link href="https://kotlinlang.slack.com/archives/C072YJ3Q91V">Slack Community</link>
+    </footer>
+</buildprofiles>

docs/pages/kotlinx-rpc/help-versions.json

@@ -0,0 +1,3 @@
+[
+  {"version":"0.1.0","url":"/kotlinx-rpc/0.1.0/","isCurrent":true}
+]