From 4025132f990b22cc7d6b53af717acc1ed3762f14 Mon Sep 17 00:00:00 2001
From: Lawrence Forooghian <lawrence@forooghian.com>
Date: Mon, 13 Nov 2023 11:29:02 -0300
Subject: [PATCH] Move TypeDoc-related stuff into its own directory
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

I think the docs/ directory is something that’s meant to contain
documentation for direct consumption by users or developers, and not
fragments that need to be glued together with something else to be
useful.
---
 .github/workflows/docs.yml        | 2 +-
 .gitignore                        | 2 +-
 package.json                      | 2 +-
 {docs => typedoc}/landing-page.md | 0
 4 files changed, 3 insertions(+), 3 deletions(-)
 rename {docs => typedoc}/landing-page.md (100%)

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 96023da288..8b5492280a 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -37,6 +37,6 @@ jobs:
       - name: Upload Documentation
         uses: ably/sdk-upload-action@v1
         with:
-          sourcePath: docs/generated
+          sourcePath: typedoc/generated
           githubToken: ${{ secrets.GITHUB_TOKEN }}
           artifactName: typedoc
diff --git a/.gitignore b/.gitignore
index 0389a38a71..832e8c2b90 100644
--- a/.gitignore
+++ b/.gitignore
@@ -6,4 +6,4 @@ npm-debug.log
 .tool-versions
 build/
 react/
-docs/generated/
+typedoc/generated/
diff --git a/package.json b/package.json
index c4054bf155..a24435e12d 100644
--- a/package.json
+++ b/package.json
@@ -133,6 +133,6 @@
     "sourcemap": "source-map-explorer build/ably.min.js",
     "sourcemap:noencryption": "source-map-explorer build/ably.noencryption.min.js",
     "modulereport": "node scripts/moduleReport.js",
-    "docs": "typedoc --entryPoints ably.d.ts --out docs/generated --readme docs/landing-page.md"
+    "docs": "typedoc --entryPoints ably.d.ts --out typedoc/generated --readme typedoc/landing-page.md"
   }
 }
diff --git a/docs/landing-page.md b/typedoc/landing-page.md
similarity index 100%
rename from docs/landing-page.md
rename to typedoc/landing-page.md