From 2f3fb37ffcca1b284523fbc69d72089a2e43c66c Mon Sep 17 00:00:00 2001
From: Sunny Hirai <thesunny@gmail.com>
Date: Wed, 12 Apr 2023 21:44:53 -0700
Subject: [PATCH] Add withHistory page to docs, reorganize the History docs in
 general and update Summary.md

---
 docs/Summary.md                               |  7 ++++---
 docs/libraries/slate-history.md               | 21 -------------------
 docs/libraries/slate-history/README.md        |  7 +++++++
 .../slate-history}/history-editor.md          |  0
 .../slate-history}/history.md                 |  0
 docs/libraries/slate-history/with-history.md  | 13 ++++++++++++
 6 files changed, 24 insertions(+), 24 deletions(-)
 delete mode 100644 docs/libraries/slate-history.md
 create mode 100644 docs/libraries/slate-history/README.md
 rename docs/{history => libraries/slate-history}/history-editor.md (100%)
 rename docs/{history => libraries/slate-history}/history.md (100%)
 create mode 100644 docs/libraries/slate-history/with-history.md

diff --git a/docs/Summary.md b/docs/Summary.md
index 740c5934f..3f98d2511 100644
--- a/docs/Summary.md
+++ b/docs/Summary.md
@@ -54,9 +54,10 @@
 ## Libraries
 
 - [Slate React](libraries/slate-react.md)
-- [Slate History](libraries/slate-history.md)
-  - [History](/history/history.md)
-  - [HistoryEditor](/history/history-editor.md)
+- [Slate History](libraries/slate-history/README.md)
+  - [withHistory](/libraries/slate-history/with-history.md)
+  - [HistoryEditor](/libraries/slate-history/history-editor.md)
+  - [History](/libraries/slate-history/history.md)
 - [Slate Hyperscript](libraries/slate-hyperscript.md)
 
 ## General
diff --git a/docs/libraries/slate-history.md b/docs/libraries/slate-history.md
deleted file mode 100644
index 682543c3a..000000000
--- a/docs/libraries/slate-history.md
+++ /dev/null
@@ -1,21 +0,0 @@
-# Slate History
-
-This sub-library tracks changes to the Slate value state over time, and enables undo and redo functionality.
-
-## `withHistory`
-
-The `withHistory` plugin adds the `HistoryEditor` to an `Editor` instance and keeps track of the operation history of a Slate editor as operations are applied to it, using undo and redo stacks.
-
-When used with `withReact`, `withHistory` should be applied inside. For example:
-
-```javascript
-const [editor] = useState(() => withReact(withHistory(createEditor())))
-```
-
-## [`HistoryEditor`](../history/history-editor.md)
-
-`HistoryEditor` is the Editor with history related methods and the `History` object property. It also contains static helpers for history-enabled editors.
-
-## [`History`](../history/history.md)
-
-`History` objects accessed at `editor.history` on a `HistoryEditor` holds all of the operations that are applied to a value, so they can be undone or redone as necessary.
diff --git a/docs/libraries/slate-history/README.md b/docs/libraries/slate-history/README.md
new file mode 100644
index 000000000..ec62f9df6
--- /dev/null
+++ b/docs/libraries/slate-history/README.md
@@ -0,0 +1,7 @@
+# Slate History
+
+This sub-library tracks changes to the Slate value state over time, and enables undo and redo functionality.
+
+- [withHistory](./with-history.md)
+- [HistoryEditor](./history-editor.md)
+- [History](./history.md)
diff --git a/docs/history/history-editor.md b/docs/libraries/slate-history/history-editor.md
similarity index 100%
rename from docs/history/history-editor.md
rename to docs/libraries/slate-history/history-editor.md
diff --git a/docs/history/history.md b/docs/libraries/slate-history/history.md
similarity index 100%
rename from docs/history/history.md
rename to docs/libraries/slate-history/history.md
diff --git a/docs/libraries/slate-history/with-history.md b/docs/libraries/slate-history/with-history.md
new file mode 100644
index 000000000..82dae667f
--- /dev/null
+++ b/docs/libraries/slate-history/with-history.md
@@ -0,0 +1,13 @@
+# withHistory
+
+The `withHistory` plugin adds the `HistoryEditor` to an `Editor` instance and keeps track of the operation history of a Slate editor as operations are applied to it, using undo and redo stacks.
+
+#### `withHistory<T extends Editor>(editor: T): T & HistoryEditor`
+
+Add `HistoryEditor` interface to an instance of any `Editor`.
+
+When used with `withReact`, `withHistory` should be applied inside. For example:
+
+```javascript
+const [editor] = useState(() => withReact(withHistory(createEditor())))
+```