docs(website): updates

unadlib · Nov 26, 2023 · 5c82486 · 5c82486
1 parent ea7f82c
commit 5c82486
Show file tree

Hide file tree

Showing 43 changed files with 321 additions and 528 deletions.
diff --git a/website/docs/tutorial-extras/_category_.json → website/docs/advanced-guides/_category_.json b/website/docs/tutorial-extras/_category_.json → website/docs/advanced-guides/_category_.json
@@ -1,5 +1,5 @@
 {
-  "label": "Tutorial - Extras",
+  "label": "Advanced Guides",
   "position": 3,
   "link": {
     "type": "generated-index"

diff --git a/website/docs/advanced-guides/auto-freeze.md b/website/docs/advanced-guides/auto-freeze.md
@@ -0,0 +1,11 @@
+---
+sidebar_position: 3
+---
+
+# Auto Freeze
+
+// todo
+
+## Enable Auto Freeze
+
+// todo
diff --git a/website/docs/advanced-guides/currying.md b/website/docs/advanced-guides/currying.md
diff --git a/...torial-extras/img/docsVersionDropdown.png → ...vanced-guides/img/docsVersionDropdown.png b/...torial-extras/img/docsVersionDropdown.png → ...vanced-guides/img/docsVersionDropdown.png
diff --git a/...cs/tutorial-extras/img/localeDropdown.png → ...cs/advanced-guides/img/localeDropdown.png b/...cs/tutorial-extras/img/localeDropdown.png → ...cs/advanced-guides/img/localeDropdown.png
diff --git a/website/docs/advanced-guides/json-patch.md b/website/docs/advanced-guides/json-patch.md
@@ -0,0 +1,9 @@
+---
+sidebar_position: 1
+---
+
+# JSON Patch
+
+Docusaurus can manage multiple versions of your docs.
+
+## Create a docs version
diff --git a/website/docs/advanced-guides/mark.md b/website/docs/advanced-guides/mark.md
@@ -0,0 +1,12 @@
+---
+sidebar_position: 2
+---
+
+# Marking for mutable and immutable data
+
+// todo
+
+## Customize mark
+
+// todo
+
diff --git a/website/docs/advanced-guides/migration.md b/website/docs/advanced-guides/migration.md
@@ -0,0 +1,12 @@
+---
+sidebar_position: 2
+---
+
+# Migration from Immer to Mutative
+
+// todo
+
+## Migration
+
+// todo
+
diff --git a/website/docs/advanced-guides/pathes.md b/website/docs/advanced-guides/pathes.md
@@ -0,0 +1,11 @@
+---
+sidebar_position: 2
+---
+
+# Patches
+
+// todo
+
+## Enable patches
+
+// todo
diff --git a/website/docs/advanced-guides/reducers.md b/website/docs/advanced-guides/reducers.md
@@ -0,0 +1,11 @@
+---
+sidebar_position: 3
+---
+
+# Reducers
+
+// todo
+
+## Reducers
+
+// todo
diff --git a/website/docs/advanced-guides/returning.md b/website/docs/advanced-guides/returning.md
@@ -0,0 +1,11 @@
+---
+sidebar_position: 3
+---
+
+# Returning new data
+
+// todo
+
+## Returning new data
+
+// todo
diff --git a/website/docs/advanced-guides/strict-mode.md b/website/docs/advanced-guides/strict-mode.md
@@ -0,0 +1,11 @@
+---
+sidebar_position: 3
+---
+
+# Strict Mode
+
+// todo
+
+## Enable strict mode
+
+// todo
diff --git a/website/docs/advanced-guides/typescript.md b/website/docs/advanced-guides/typescript.md
@@ -0,0 +1,11 @@
+---
+sidebar_position: 3
+---
+
+# Typescript
+
+// todo
+
+## Using Typescript
+
+// todo
diff --git a/website/docs/api-reference/_category_.json b/website/docs/api-reference/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "API Reference",
+  "position": 4,
+  "link": {
+    "type": "generated-index",
+    "description": "5 minutes to learn the most important Docusaurus concepts."
+  }
+}
diff --git a/website/docs/api-reference/apply.md b/website/docs/api-reference/apply.md
@@ -0,0 +1,12 @@
+---
+sidebar_position: 6
+---
+
+# apply()
+
+// TODO
+
+## Usage
+
+// TODO
+
diff --git a/website/docs/api-reference/create.md b/website/docs/api-reference/create.md
@@ -0,0 +1,12 @@
+---
+sidebar_position: 6
+---
+
+# create()
+
+// TODO
+
+## Usage
+
+// TODO
+
diff --git a/website/docs/api-reference/current.md b/website/docs/api-reference/current.md
@@ -0,0 +1,12 @@
+---
+sidebar_position: 6
+---
+
+# current()
+
+// TODO
+
+## Usage
+
+// TODO
+
diff --git a/website/docs/api-reference/isdraft.md b/website/docs/api-reference/isdraft.md
@@ -0,0 +1,12 @@
+---
+sidebar_position: 6
+---
+
+# isDraft()
+
+// TODO
+
+## Usage
+
+// TODO
+
diff --git a/website/docs/api-reference/isdraftable.md b/website/docs/api-reference/isdraftable.md
@@ -0,0 +1,12 @@
+---
+sidebar_position: 6
+---
+
+# isDraftable()
+
+// TODO
+
+## Usage
+
+// TODO
+
diff --git a/website/docs/api-reference/makecreator.md b/website/docs/api-reference/makecreator.md
@@ -0,0 +1,12 @@
+---
+sidebar_position: 6
+---
+
+# makeCreator()
+
+// TODO
+
+## Usage
+
+// TODO
+
diff --git a/website/docs/api-reference/original.md b/website/docs/api-reference/original.md
@@ -0,0 +1,12 @@
+---
+sidebar_position: 6
+---
+
+# original()
+
+// TODO
+
+## Usage
+
+// TODO
+
diff --git a/website/docs/api-reference/rawreturn.md b/website/docs/api-reference/rawreturn.md
@@ -0,0 +1,12 @@
+---
+sidebar_position: 6
+---
+
+# rawReturn()
+
+// TODO
+
+## Usage
+
+// TODO
+
diff --git a/website/docs/api-reference/unsafe.md b/website/docs/api-reference/unsafe.md
@@ -0,0 +1,12 @@
+---
+sidebar_position: 6
+---
+
+# unsafe()
+
+// TODO
+
+## Usage
+
+// TODO
+
diff --git a/website/docs/extra-topics/_category_.json b/website/docs/extra-topics/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "Extra Topics",
+  "position": 5,
+  "link": {
+    "type": "generated-index",
+    "description": "5 minutes to learn the most important Docusaurus concepts."
+  }
+}
diff --git a/website/docs/extra-topics/comparison-with-immer.md b/website/docs/extra-topics/comparison-with-immer.md
@@ -0,0 +1,12 @@
+---
+sidebar_position: 6
+---
+
+# Comparison with Immer
+
+// todo
+
+## Comparison with Immer
+
+// todo
+
diff --git a/website/docs/extra-topics/contributing.md b/website/docs/extra-topics/contributing.md
@@ -0,0 +1,12 @@
+---
+sidebar_position: 6
+---
+
+# Contributing
+
+// todo
+
+## Contributing
+
+// todo
+
diff --git a/website/docs/extra-topics/faq.md b/website/docs/extra-topics/faq.md
@@ -0,0 +1,12 @@
+---
+sidebar_position: 6
+---
+
+# FAQ
+
+// todo
+
+## Q&A
+
+// todo
+
diff --git a/website/docs/extra-topics/performance.md b/website/docs/extra-topics/performance.md
@@ -0,0 +1,12 @@
+---
+sidebar_position: 6
+---
+
+# Performance
+
+// todo
+
+## Benchmark
+
+// todo
+
diff --git a/website/docs/tutorial-basics/_category_.json → website/docs/getting-started/_category_.json b/website/docs/tutorial-basics/_category_.json → website/docs/getting-started/_category_.json
@@ -1,5 +1,5 @@
 {
-  "label": "Tutorial - Basics",
+  "label": "Getting Started",
   "position": 2,
   "link": {
     "type": "generated-index",

diff --git a/website/docs/getting-started/concepts.md b/website/docs/getting-started/concepts.md
@@ -0,0 +1,10 @@
+---
+sidebar_position: 3
+---
+
+# Concepts
+
+// todo
+
+## Drafts
+// todo
diff --git a/website/docs/getting-started/installation.md b/website/docs/getting-started/installation.md
@@ -0,0 +1,19 @@
+---
+sidebar_position: 1
+---
+
+# Installation
+
+// todo
+
+## Using Mutative from NPM/Yarn
+
+// todo
+
+## Using Mutative from CDN
+
+// todo
+
+## Try Mutative with React
+
+// todo
diff --git a/website/docs/getting-started/mutative-with-react.md b/website/docs/getting-started/mutative-with-react.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 3
+---
+
+# Using Immer with React
+
+// todo
diff --git a/website/docs/getting-started/usages.md b/website/docs/getting-started/usages.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 3
+---
+
+# Usages
+
+// todo