docs: add a reference section with operations (how to upgrade mud) (#…

…1225)
latticexyz · Aug 1, 2023 · 7fb0dad · 7fb0dad
1 parent d89431d
commit 7fb0dad
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 0 deletions.
diff --git a/docs/pages/_meta.js b/docs/pages/_meta.js
@@ -10,6 +10,7 @@ export default {
   ecs: "ECS and MUD",
   plugins: "Plugins",
   tutorials: "Tutorials",
+  reference: "Reference",  
   contribute: "Contribute",
   roadmap: {
     title: "Roadmap",

diff --git a/docs/pages/reference.mdx b/docs/pages/reference.mdx
@@ -0,0 +1,37 @@
+# Reference
+
+## Operations
+
+### Create a new codebase
+
+- Using the latest snapshot release:
+
+  ```
+  pnpm create mud@main <directory>
+  ```
+
+- Using the latest pre-release:
+
+  ```
+  pnpm create mud@next <directory>
+  ```
+
+  ### Modify the codebase version
+
+- Switch to the latest snapshot release:
+
+  ```
+  pnpm mud set-version --tag main && pnpm install
+  ```
+
+- Switch to the latest pre-release:
+
+  ```
+  pnpm mud set-version --tag next && pnpm install
+  ```
+
+- Switch to [a specific commit](https://github.com/latticexyz/mud/commits/main):
+
+  ```
+  pnpm mud set-version --commit <hash> && pnpm install
+  ```