feat: initial docs setup

callstack · Feb 16, 2024 · e106975 · e106975
1 parent 9de7a12
commit e106975
Show file tree

Hide file tree

Showing 40 changed files with 8,449 additions and 1,270 deletions.
diff --git a/blog/2019-05-28-first-blog-post.md b/blog/2019-05-28-first-blog-post.md
diff --git a/blog/2019-05-29-long-blog-post.md b/blog/2019-05-29-long-blog-post.md
diff --git a/blog/2021-08-01-mdx-blog-post.mdx b/blog/2021-08-01-mdx-blog-post.mdx
diff --git a/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg b/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg
diff --git a/blog/2021-08-26-welcome/index.md b/blog/2021-08-26-welcome/index.md
diff --git a/blog/authors.yml b/blog/authors.yml
diff --git a/docs/getting-started/_category_.json b/docs/getting-started/_category_.json
@@ -0,0 +1,9 @@
+{
+    "label": "Getting Started",
+    "position": 2,
+    "link": {
+      "type": "generated-index"
+    },
+    "collapsed": false
+  }
+
diff --git a/docs/getting-started/create-first-app.md b/docs/getting-started/create-first-app.md
@@ -0,0 +1,27 @@
+---
+sidebar_position: 2
+---
+
+# Create your first App
+
+1. Make sure you have a [proper development environment setup](https://reactnative.dev/docs/environment-setup)
+2. Download the latest Xcode (at least 15.2).
+3. Install visionOS simulator runtime.
+4. Install the latest version of CMake (at least v3.28.0).
+5. Initialize the project using this command:
+
+```sh
+npx @callstack/react-native-visionos@latest init YourApp
+```
+
+6. Next, go to `YourApp/visionos` folder and run following commands to install Pods:
+
+```sh
+bundle install
+bundle exec pod install
+```
+
+7. Now you can run `yarn visionos`
+8. (Optional) you also can open project using Xcode (`xed YourApp/visionos/YourApp.xcworkspace`).
+
+- Build the app by clicking the "Run" button in Xcode.
diff --git a/docs/getting-started/platform-guidelines.md b/docs/getting-started/platform-guidelines.md
@@ -0,0 +1,5 @@
+# Platform Guidelines
+
+We suggest you read [Human Interface Guidelines for visionOS](https://developer.apple.com/design/human-interface-guidelines/designing-for-visionos) when creating visionOS apps.
+
+It's important not to cover the translucent background with a solid color, as it helps to ground apps and make them feel like part of the environment.
diff --git a/docs/intro.md b/docs/intro.md
@@ -1,47 +1,26 @@
 ---
 sidebar_position: 1
+slug: /
 ---
 
-# Tutorial Intro
+# Introduction
 
-Let's discover **Docusaurus in less than 5 minutes**.
+:::warning
 
-## Getting Started
+This project is still at an early stage of development and is not ready for production use.
 
-Get started by **creating a new site**.
+:::
 
-Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
+> Learn once, write anywhere: Build spatial apps with React.
 
-### What you'll need
+React Native visionOS allows you to write visionOS **apps with full support for platform SDK**. This is a full fork of the main repository with changes needed to support visionOS.
 
-- [Node.js](https://nodejs.org/en/download/) version 18.0 or above:
-  - When installing Node.js, you are recommended to check all checkboxes related to dependencies.
+![Welcome](../static/img/welcome-rn-visionos.png)
 
-## Generate a new site
+## How is it different from running app in compatibility mode?
 
-Generate a new Docusaurus site using the **classic template**.
+React Native visionOS unlocks full capabilities of the platform, giving your app transparent look that feels right at home next to other visionOS apps. It allows you to leverage the power of ImmersiveSpaces and multi-window apps.
 
-The classic template will automatically be added to your project after you run the command:
+Side by side comparison of running the same app: React Native visionOS vs React Native iOS (Compatibility mode).
 
-```bash
-npm init docusaurus@latest my-website classic
-```
-
-You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
-
-The command also installs all necessary dependencies you need to run Docusaurus.
-
-## Start your site
-
-Run the development server:
-
-```bash
-cd my-website
-npm run start
-```
-
-The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
-
-The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
-
-Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.
+<video width="100%" controls src="https://github.com/callstack/react-native-visionos/assets/52801365/dd5d6351-3843-4f4a-ae67-541c068ac7be"/>
diff --git a/docs/tutorial-basics/_category_.json b/docs/tutorial-basics/_category_.json
diff --git a/docs/tutorial-basics/congratulations.md b/docs/tutorial-basics/congratulations.md
diff --git a/docs/tutorial-basics/create-a-blog-post.md b/docs/tutorial-basics/create-a-blog-post.md
diff --git a/docs/tutorial-basics/create-a-document.md b/docs/tutorial-basics/create-a-document.md
diff --git a/docs/tutorial-basics/create-a-page.md b/docs/tutorial-basics/create-a-page.md