docs: add examples

amos-project · Nov 1, 2024 · 2efdd6d · 2efdd6d
1 parent 229c16f
commit 2efdd6d
Show file tree

Hide file tree

Showing 21 changed files with 27 additions and 15 deletions.
diff --git a/.yarn/install-state.gz b/.yarn/install-state.gz
diff --git a/examples/Counter/package.json b/examples/Counter/package.json
@@ -9,6 +9,7 @@
     "preview": "vite preview"
   },
   "dependencies": {
+    "amos": "^0.3.0-beta.28",
     "react": "^18.3.1",
     "react-dom": "^18.3.1"
   },

diff --git a/examples/Counter/tsconfig.json b/examples/Counter/tsconfig.json
@@ -1,7 +1,10 @@
 {
   "extends": "../../tsconfig.json",
   "compilerOptions": {
-    "lib": ["ES2022", "DOM"],
+    "lib": [
+      "ES2022",
+      "DOM"
+    ],
     "declaration": false,
     "emitDeclarationOnly": false
   }

diff --git a/examples/TodoMVC/package.json b/examples/TodoMVC/package.json
@@ -9,6 +9,7 @@
     "preview": "vite preview"
   },
   "dependencies": {
+    "amos": "^0.3.0-beta.28",
     "react": "^18.3.1",
     "react-dom": "^18.3.1"
   },

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@amos/root",
   "private": true,
-  "version": "0.3.0-beta.27",
+  "version": "0.3.0-beta.28",
   "license": "MIT",
   "workspaces": [
     "packages/*",

diff --git a/packages/amos-babel/package.json b/packages/amos-babel/package.json
@@ -1,6 +1,6 @@
 {
   "name": "amos-babel",
-  "version": "0.3.0-beta.27",
+  "version": "0.3.0-beta.28",
   "private": true,
   "files": [],
   "peerDependencies": {

diff --git a/packages/amos-boxes/package.json b/packages/amos-boxes/package.json
@@ -1,6 +1,6 @@
 {
   "name": "amos-boxes",
-  "version": "0.3.0-beta.27",
+  "version": "0.3.0-beta.28",
   "private": true,
   "files": []
 }
diff --git a/packages/amos-core/package.json b/packages/amos-core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "amos-core",
-  "version": "0.3.0-beta.27",
+  "version": "0.3.0-beta.28",
   "private": true,
   "files": []
 }
diff --git a/packages/amos-io/package.json b/packages/amos-io/package.json
@@ -1,6 +1,6 @@
 {
   "name": "amos-io",
-  "version": "0.3.0-beta.27",
+  "version": "0.3.0-beta.28",
   "private": true,
   "files": []
 }
diff --git a/packages/amos-persist/package.json b/packages/amos-persist/package.json
@@ -1,6 +1,6 @@
 {
   "name": "amos-persist",
-  "version": "0.3.0-beta.27",
+  "version": "0.3.0-beta.28",
   "private": true,
   "files": []
 }
diff --git a/packages/amos-react/package.json b/packages/amos-react/package.json
@@ -1,6 +1,6 @@
 {
   "name": "amos-react",
-  "version": "0.3.0-beta.27",
+  "version": "0.3.0-beta.28",
   "private": true,
   "files": [],
   "peerDependencies": {

diff --git a/packages/amos-shapes/package.json b/packages/amos-shapes/package.json
@@ -1,6 +1,6 @@
 {
   "name": "amos-shapes",
-  "version": "0.3.0-beta.27",
+  "version": "0.3.0-beta.28",
   "private": true,
   "files": []
 }
diff --git a/packages/amos-testing/package.json b/packages/amos-testing/package.json
@@ -1,6 +1,6 @@
 {
   "name": "amos-testing",
-  "version": "0.3.0-beta.27",
+  "version": "0.3.0-beta.28",
   "private": true,
   "files": []
 }
diff --git a/packages/amos-typescript/package.json b/packages/amos-typescript/package.json
@@ -1,6 +1,6 @@
 {
   "name": "amos-typescript",
-  "version": "0.3.0-beta.27",
+  "version": "0.3.0-beta.28",
   "private": true,
   "files": [],
   "peerDependencies": {

diff --git a/packages/amos-utils/package.json b/packages/amos-utils/package.json
@@ -1,6 +1,6 @@
 {
   "name": "amos-utils",
-  "version": "0.3.0-beta.27",
+  "version": "0.3.0-beta.28",
   "private": true,
   "files": []
 }
diff --git a/packages/amos/package.json b/packages/amos/package.json
@@ -1,6 +1,6 @@
 {
   "name": "amos",
-  "version": "0.3.0-beta.27",
+  "version": "0.3.0-beta.28",
   "description": "An out-of-the-box state management library designed for your large-scale projects.",
   "keywords": [
     "amos",

diff --git a/website/docs/01-Introduction/01-get-started.md b/website/docs/01-Introduction/01-get-started.md
@@ -73,5 +73,5 @@ Next, you can go to the [Concepts](./03-concepts.md) page to learn about the cor
 explore topics of interest in the menu on the left 👈 of this document.
 
 We recommend starting with our
-article, [How to design state in large-scale applications](./04-how-to.md), to understand the
+article, [How to design state in large-scale applications](./05-how-to.md), to understand the
 reasoning behind Amos's design and to help you make the most of it.
diff --git a/website/docs/01-Introduction/04-examples.md b/website/docs/01-Introduction/04-examples.md
@@ -0,0 +1,3 @@
+# Examples
+
+## TodoMVC
diff --git a/website/docs/01-Introduction/04-how-to.md → website/docs/01-Introduction/05-how-to.md b/website/docs/01-Introduction/04-how-to.md → website/docs/01-Introduction/05-how-to.md
diff --git a/website/src/theme/ReactLiveScope/index.tsx b/website/src/theme/ReactLiveScope/index.tsx
@@ -1,3 +1,4 @@
+import {App} from '../../../../examples/TodoMVC/src/App';
 import React from 'react';
 import * as Amos from 'amos';
 import * as AmosReact from 'amos/react';
@@ -14,6 +15,7 @@ const ReactLiveScope = {
   React,
   ...Amos,
   ...AmosReact,
+  TodoMVC: App,
   require,
 };
 

diff --git a/yarn.lock b/yarn.lock
@@ -5227,6 +5227,7 @@ __metadata:
     "@types/react": "npm:^18.3.10"
     "@types/react-dom": "npm:^18.3.0"
     "@vitejs/plugin-react": "npm:^4.3.2"
+    amos: "npm:^0.3.0-beta.28"
     globals: "npm:^15.9.0"
     react: "npm:^18.3.1"
     react-dom: "npm:^18.3.1"
@@ -5242,6 +5243,7 @@ __metadata:
     "@types/react": "npm:^18.3.10"
     "@types/react-dom": "npm:^18.3.0"
     "@vitejs/plugin-react": "npm:^4.3.2"
+    amos: "npm:^0.3.0-beta.28"
     globals: "npm:^15.9.0"
     react: "npm:^18.3.1"
     react-dom: "npm:^18.3.1"
@@ -5315,7 +5317,7 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"amos@workspace:packages/amos":
+"amos@npm:^0.3.0-beta.28, amos@workspace:packages/amos":
   version: 0.0.0-use.local
   resolution: "amos@workspace:packages/amos"
   dependencies: