[typedoc] Link to the main existing docs.

cubing · Jul 18, 2022 · 4008c20 · 4008c20
1 parent 75e1e98
commit 4008c20
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 0 deletions.
diff --git 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
@@ -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
@@ -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";