Add docs (#10)

* Add docs

* fix task name

.github/workflows/update-docs.yaml

@@ -0,0 +1,48 @@
+name: Build documentation
+
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+env:
+  INSTANCE: 'Writerside/doc'
+  ARTIFACT: 'webHelpDOC2-all.zip'
+  DOCKER_VERSION: '241.16003'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 #v4.1.7
+        with:
+          fetch-depth: 0
+
+      - name: Build docs using Writerside Docker builder
+        uses: JetBrains/writerside-github-action@5a6920dbce3ef3169acbeb7e45c6cbdaf7e76bfa #v4
+        with:
+          instance: ${{ env.INSTANCE }}
+          artifact: ${{ env.ARTIFACT }}
+          docker-version: ${{ env.DOCKER_VERSION }}
+
+      - name: Prepare static content
+        run: |
+          ./gradlew dokkatooGeneratePublicationHtml
+          mkdir -p build/static
+          cp -rf build/dokka/html build/static/kdoc
+          unzip artifacts/webHelpDOC2-all.zip -d build/static
+
+      - name: Deploy Kdoc to github pages
+        uses: JamesIves/github-pages-deploy-action@5c6e9e9f3672ce8fd37b9856193d2a537941e66c #v4.6.1
+        with:
+          branch: gh-pages # The branch the action should deploy to.
+          folder: build/static # The folder the action should deploy.
+
+      - name: Save artifact with build results
+        uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 #v4.3.3
+        with:
+          name: docs
+          path: |
+            artifacts/${{ env.ARTIFACT }}
+          retention-days: 7

.gitignore

@@ -11,6 +11,7 @@
 
 # Generated files
 build
+/reports
 .kotlin
 
 # Place where the Android SDK path is set
@@ -23,4 +24,3 @@ project.xcworkspace
 # Mac OS Finder
 .DS_Store
 Thumbs.db
-

CODEOWNERS

@@ -0,0 +1 @@
+* @martinbonnin @BoD

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-__COPYRIGHT_LINE__
+Copyright (c) 2016-2024 Apollo Graph, Inc. (Formerly Meteor Development Group, Inc.)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -0,0 +1,26 @@
+<div align="center">
+
+<p>
+	<a href="https://www.apollographql.com/"><img src="https://raw.githubusercontent.com/apollographql/apollo-client-devtools/a7147d7db5e29b28224821bf238ba8e3a2fdf904/assets/apollo-wordmark.svg" height="100" alt="Apollo Client"></a>
+</p>
+
+[![Discourse](https://img.shields.io/discourse/topics?label=Discourse&server=https%3A%2F%2Fcommunity.apollographql.com&logo=discourse&color=467B95&style=flat-square)](http://community.apollographql.com/new-topic?category=Help&tags=mobile,client)
+[![Slack](https://img.shields.io/static/v1?label=kotlinlang&message=apollo-kotlin&color=A97BFF&logo=slack&style=flat-square)](https://app.slack.com/client/T09229ZC6/C01A6KM1SBZ)
+[![Discord](https://img.shields.io/discord/1022972389463687228.svg?color=7389D8&labelColor=6A7EC2&logo=discord&logoColor=ffffff&style=flat-square)](https://discord.com/invite/graphos)
+
+[![Maven Central](https://img.shields.io/maven-central/v/com.apollographql.cli/apollo-cli?style=flat-square)](https://central.sonatype.com/namespace/com.apollographql.cli)
+[![OSS Snapshots](https://img.shields.io/nexus/s/com.apollographql.cli/apollo-cli?server=https%3A%2F%2Fs01.oss.sonatype.org&label=oss-snapshots&style=flat-square)](https://s01.oss.sonatype.org/content/repositories/snapshots/com/apollographql/cli/)
+
+</div>
+
+## 🚀 Apollo Cli
+
+Command line tool for your GraphQL projects.
+
+## 📚 Documentation
+
+See the project website for documentation:<br/>
+[https://apollographql.github.io/apollo-kotlin-cli/](https://apollographql.github.io/apollo-kotlin-cli/)
+
+The Kdoc API reference can be found at:<br/>
+[https://apollographql.github.io/apollo-kotlin-cli/kdoc](https://apollographql.github.io/apollo-kotlin-cli/kdoc)

Writerside/c.list

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE categories
+        SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
+<categories>
+    <category id="wrs" name="Writerside documentation" order="1"/>
+</categories>

Writerside/cfg/buildprofiles.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
+               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+
+    <variables></variables>
+  <build-profile instance="doc">
+    <variables>
+      <header-logo>apollo_logo.svg</header-logo>
+      <custom-favicons>favicon-96x96.png,favicon-192x192.png</custom-favicons>
+      <noindex-content>true</noindex-content>
+      <download-title>GitHub</download-title>
+      <download-page>https://github.com/apollographql/apollo-kotlin-cli/</download-page>
+      <showDownloadButton>true</showDownloadButton>
+      <enable-browser-edits>true</enable-browser-edits>
+      <browser-edits-url>https://github.com/apollographql/apollo-kotlin-cli/edit/main/Writerside/</browser-edits-url>
+    </variables>
+  </build-profile>
+</buildprofiles>

Writerside/writerside.cfg

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE ihp SYSTEM "https://resources.jetbrains.com/writerside/1.0/ihp.dtd">
+
+<ihp version="2.0">
+    <topics dir="topics" web-path="topics"/>
+    <images dir="images" web-path="images"/>
+  <instance src="doc.tree" />
+</ihp>

librarian.properties

@@ -10,7 +10,7 @@ git.snapshots=main
 
 pom.groupId=com.apollographql.cli
 pom.version=0.0.4-SNAPSHOT
-pom.description=apollo-kotlin-cli
+pom.description=Command line tool for your GraphQL projects
 pom.vcsUrl=https://github.com/apollographql/apollo-kotlin-cli
 pom.developer=apollo-kotlin-cli authors
 pom.license=MIT License