From 6e34de92a53379c0e740bea94fd0a3653cfedbb7 Mon Sep 17 00:00:00 2001
From: Gus Narea <gnarea@users.noreply.github.com>
Date: Fri, 6 Sep 2024 16:38:15 +0100
Subject: [PATCH] chore(release): Replace Jekyll docs with TypeDoc

---
 .github/workflows/ci.yml |  2 --
 docs/gcp.md => api.md    | 16 ++++++++++++----
 docs/_config.yml         | 14 --------------
 docs/index.md            | 12 ------------
 typedoc.json             |  3 ++-
 5 files changed, 14 insertions(+), 33 deletions(-)
 rename docs/gcp.md => api.md (82%)
 delete mode 100644 docs/_config.yml
 delete mode 100644 docs/index.md

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 5ad1fc87..c9e9fe84 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -10,7 +10,5 @@ jobs:
   release:
     needs: ci
     uses: relaycorp/shared-workflows/.github/workflows/nodejs-lib-release.yml@main
-    with:
-      jekyll_docs: true
     secrets:
       npm_token: ${{ secrets.NPM_TOKEN }}
diff --git a/docs/gcp.md b/api.md
similarity index 82%
rename from docs/gcp.md
rename to api.md
index dc2c7d3f..53849213 100644
--- a/docs/gcp.md
+++ b/api.md
@@ -1,7 +1,15 @@
----
-nav_order: 1
-permalink: /gcp
----
+# Overview
+
+`@relaycorp/awala-keystore-cloud` is a Node.js library that implements
+[Awala](https://awala.network/) private key stores across a range of cloud providers and open
+source backing services, so that server-side apps can be deployed to a wide variety of platforms.
+
+Most of this documentation is aimed at _operators_ of those server-side apps using this library.
+To get help, learn how to integrate this library or contribute to this library, please refer to the
+[GitHub project](https://github.com/relaycorp/awala-keystore-cloud-js).
+
+The following platforms are currently supported:
+
 # Google Cloud Platform (GCP)
 
 The GCP key store only uses [Cloud KMS](https://cloud.google.com/kms), which is serverless and fully managed by Google, so you don't need to worry about up/down scaling or uptime/performance monitoring. We protect sensitive cryptographic material with Cloud KMS as follows:
diff --git a/docs/_config.yml b/docs/_config.yml
deleted file mode 100644
index 33e9a6c2..00000000
--- a/docs/_config.yml
+++ /dev/null
@@ -1,14 +0,0 @@
-title: "@relaycorp/awala-keystore-cloud"
-
-markdown: kramdown
-
-baseurl: /awala-keystore-cloud-js
-remote_theme: just-the-docs/just-the-docs@v0.3.3
-
-footer_content: "Copyright &copy; 2022 Relaycorp, Inc."
-
-aux_links:
-  "GitHub project":
-    - "https://github.com/relaycorp/awala-keystore-cloud-js"
-
-search_enabled: false
diff --git a/docs/index.md b/docs/index.md
deleted file mode 100644
index 4ec824b2..00000000
--- a/docs/index.md
+++ /dev/null
@@ -1,12 +0,0 @@
----
-nav_order: 0
----
-# @relaycorp/awala-keystore-cloud
-
-`@relaycorp/awala-keystore-cloud` is a Node.js library that implements [Awala](https://awala.network/) private key stores across a range of cloud providers and open source backing services, so that server-side apps can be deployed to a wide variety of platforms.
-
-Most of this documentation is aimed at _operators_ of those server-side apps using this library. To get help, learn how to integrate this library or contribute to this library, please refer to the [GitHub project](https://github.com/relaycorp/awala-keystore-cloud-js).
-
-The following platforms are currently supported:
-
-- [Google Cloud Platform (GCP)](gcp.md).
diff --git a/typedoc.json b/typedoc.json
index a8d9e416..c8ee6b6c 100644
--- a/typedoc.json
+++ b/typedoc.json
@@ -2,5 +2,6 @@
   "exclude": ["**/*.spec.ts"],
   "excludePrivate": true,
   "excludeProtected": true,
-  "theme": "minimal"
+  "theme": "default",
+  "readme": "api.md"
 }