From 4008c209deb63bc62eae7f1d2f5934950714485f Mon Sep 17 00:00:00 2001
From: Lucas Garron <code@garron.net>
Date: Mon, 18 Jul 2022 02:23:11 -0700
Subject: [PATCH] [typedoc] Link to the main existing docs.

---
 src/cubing/alg/index.ts      | 8 ++++++++
 src/cubing/scramble/index.ts | 8 ++++++++
 src/cubing/twisty/index.ts   | 8 ++++++++
 3 files changed, 24 insertions(+)

diff --git a/src/cubing/alg/index.ts b/src/cubing/alg/index.ts
index fb843d7ba..0c45e8465 100644
--- a/src/cubing/alg/index.ts
+++ b/src/cubing/alg/index.ts
@@ -1,3 +1,11 @@
+/**
+ * For a walkthrough, see:
+ *
+ * https://js.cubing.net/cubing/alg/
+ *
+ * @packageDocumentation
+ */
+
 export { Alg } from "./Alg";
 export { AlgBuilder } from "./AlgBuilder";
 export { TraversalDownUp, TraversalUp } from "./traversal";
diff --git a/src/cubing/scramble/index.ts b/src/cubing/scramble/index.ts
index e8c11a057..20f3527fa 100644
--- a/src/cubing/scramble/index.ts
+++ b/src/cubing/scramble/index.ts
@@ -1 +1,9 @@
+/**
+ * For a walkthrough, see:
+ *
+ * https://js.cubing.net/cubing/scramble/
+ *
+ * @packageDocumentation
+ */
+
 export { randomScrambleForEvent } from "../search/cubing-private";
diff --git a/src/cubing/twisty/index.ts b/src/cubing/twisty/index.ts
index 9831f23fe..28fe35cfc 100644
--- a/src/cubing/twisty/index.ts
+++ b/src/cubing/twisty/index.ts
@@ -1,3 +1,11 @@
+/**
+ * For a walkthrough, see:
+ *
+ * https://js.cubing.net/cubing/twisty/
+ *
+ * @packageDocumentation
+ */
+
 export { TwistyPlayer } from "./views/TwistyPlayer";
 export { TwistyAlgViewer } from "./views/TwistyAlgViewer";
 export { TwistyAlgEditor } from "./views/TwistyAlgEditor/TwistyAlgEditor";