chore(docs): migrate mintlify docs in to monorepo (#335)

rivet-gg · Jun 8, 2024 · 151a017 · 151a017
1 parent 0f6dc87
commit 151a017
Show file tree

Hide file tree

Showing 113 changed files with 7,197 additions and 0 deletions.
diff --git a/docs/CONVENTIONS.md → docs-old/CONVENTIONS.md b/docs/CONVENTIONS.md → docs-old/CONVENTIONS.md
diff --git a/docs/ERROR_HANDLING.md → docs-old/ERROR_HANDLING.md b/docs/ERROR_HANDLING.md → docs-old/ERROR_HANDLING.md
diff --git a/docs/FAQ.md → docs-old/FAQ.md b/docs/FAQ.md → docs-old/FAQ.md
diff --git a/docs/KNOWN_ISSUES.md → docs-old/KNOWN_ISSUES.md b/docs/KNOWN_ISSUES.md → docs-old/KNOWN_ISSUES.md
diff --git a/docs/MODULE_ISOLATION.md → docs-old/MODULE_ISOLATION.md b/docs/MODULE_ISOLATION.md → docs-old/MODULE_ISOLATION.md
diff --git a/docs/TIPS.md → docs-old/TIPS.md b/docs/TIPS.md → docs-old/TIPS.md
diff --git a/docs/evaluations/CACHING.md → docs-old/evaluations/CACHING.md b/docs/evaluations/CACHING.md → docs-old/evaluations/CACHING.md
diff --git a/docs/evaluations/DB.md → docs-old/evaluations/DB.md b/docs/evaluations/DB.md → docs-old/evaluations/DB.md
diff --git a/docs/evaluations/DRIZZLE.md → docs-old/evaluations/DRIZZLE.md b/docs/evaluations/DRIZZLE.md → docs-old/evaluations/DRIZZLE.md
diff --git a/docs/evaluations/MIDDLEWARE_BRAINSTORM.md → ...-old/evaluations/MIDDLEWARE_BRAINSTORM.md b/docs/evaluations/MIDDLEWARE_BRAINSTORM.md → ...-old/evaluations/MIDDLEWARE_BRAINSTORM.md
diff --git a/docs/getting-started/FOR_GODOT.md → docs-old/getting-started/FOR_GODOT.md b/docs/getting-started/FOR_GODOT.md → docs-old/getting-started/FOR_GODOT.md
diff --git a/docs/getting-started/FOR_UNITY.md → docs-old/getting-started/FOR_UNITY.md b/docs/getting-started/FOR_UNITY.md → docs-old/getting-started/FOR_UNITY.md
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,37 @@
+# Created by https://www.toptal.com/developers/gitignore/api/macos
+# Edit at https://www.toptal.com/developers/gitignore?templates=macos
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+# End of https://www.toptal.com/developers/gitignore/api/macos
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,24 @@
+# Open Game Backend Documentation
+
+### Development
+
+Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command
+
+```
+npm i -g mintlify
+```
+
+Run the following command at the root of your documentation (where mint.json is)
+
+```
+mintlify dev
+```
+
+### Publishing Changes
+
+Changes will be deployed to production automatically after pushing to the default branch.
+
+#### Troubleshooting
+
+- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
+- Page loads as a 404 - Make sure you are running in a folder with `mint.json`