Merge pull request #2 from callstack/docs/migrate-from-readme

docs: migrate from README

Author: okwasniewski

README.md

@@ -1,4 +1,4 @@
-# Website
+# React Native visionOS Docs
 
 This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
 

docs/api/XR.md

@@ -0,0 +1,64 @@
+Manage Immersive Experiences.
+
+## Methods
+
+#### **`requestSession`**
+
+```js
+requestSession: (sessionId?: string) => Promise<void>
+```
+
+Opens a new [`ImmersiveSpace`](https://developer.apple.com/documentation/swiftui/immersive-spaces) given it's unique `Id`.
+
+:::warning
+
+Opening an `ImmersiveSpace` can fail in following scenarios:
+
+- `ImmersiveSpace` is not declared.
+- `UIApplicationSupportsMultipleScenes` is set to `false`.
+- User cancels the request.
+
+:::
+
+#### **`endSession`**
+
+```js
+endSession: () => Promise<void>
+```
+
+Closes currently open `ImmersiveSpace`.
+
+## Constants
+
+#### **`supportsMultipleScenes`**
+
+```js
+supportsMultipleScenes: boolean;
+```
+
+A Boolean value that indicates whether the app may display multiple scenes simultaneously. Returns the value of `UIApplicationSupportsMultipleScenes` key from `Info.plist`.
+
+:::info
+
+## UIApplicationSupportsMultipleScenes
+
+In order to use this API, make sure your app supports multiple scenes. Set `UIApplicationSupportsMultipleScenes` to `true` in `Info.plist`:
+
+```json
+<dict>
+  <key>UIApplicationSceneManifest</key>
+  <dict>
+    <key>UIApplicationPreferredDefaultSceneSessionRole</key>
+    <string>UIWindowSceneSessionRoleApplication</string>
+    <key>UIApplicationSupportsMultipleScenes</key>
+    // highlight-next-line
+    <true/>
+    <key>UISceneConfigurations</key>
+    <dict/>
+  </dict>
+</dict>
+</plist>
+
+```
+
+:::

docs/api/hoverEffect.md

@@ -0,0 +1,19 @@
+# Hover Effects
+
+:::warning
+
+This prop is soon to be removed in favour of applying this effect using `cursor: pointer` style.
+
+:::
+
+This is a prop on `<View />` component allowing to add hover effect. It's applied to all Touchable and Pressable components by default.
+
+If you want to customize it you can use the `visionos_hoverEffect` prop, like so:
+
+```tsx
+<TouchableOpacity visionos_hoverEffect="lift">
+  <Text>Click me</Text>
+</TouchableOpacity>
+```
+
+The available options are: `lift` or `highlight`.

docs/api/intro.md

@@ -0,0 +1,12 @@
+---
+sidebar_position: 1
+---
+
+# Introduction
+
+React Native visionOS builds upon APIs provided by [React Native Core](https://reactnative.dev), so every API listed in React Native docs is available, this documentation lists React Native visionOS specific APIs.
+
+### List of APIs provided by React Native visionOS
+
+- `XR` - API to manage Immersive Experiences
+- `visionos_hoverEffect` - Hover effects (soon to be removed in favour of `cursor: 'pointer'`).

docs/getting-started/_category_.json renamed to docs/docs/getting-started/_category_.json

@@ -0,0 +1,20 @@
+# App Entry Point
+
+React Native visionOS uses SwiftUI lifecycle. The app entry point is now App.swift file (by default it is main.m). This change allows us to use full capabilities of the visionOS SDK.
+
+Here is an example from the template:
+
+```swift title="App.swift"
+@main
+struct HelloWorldApp: App {
+  @UIApplicationDelegateAdaptor var delegate: AppDelegate
+
+  var body: some Scene {
+    RCTMainWindow(moduleName: "HelloWorld")
+  }
+}
+```
+
+We are using `@UIApplicationDelegateAdaptor`, a property wrapper that allows us to use familiar `AppDelegate` in SwiftUI life cycle.
+
+`AppDelegate` extends `RCTAppDelegate` which does most of React Native initialization.

docs/getting-started/create-first-app.md renamed to docs/docs/getting-started/create-first-app.md

@@ -0,0 +1,25 @@
+# Folder Structure
+
+React Native visionOS builds upon the same template used for iOS and Android. Native visionOS files are stored inside of `visionos` folder (that's why it's required to run `pod install` in this folder instead of `ios`).
+
+Your folder structure should look like so:
+
+```
+SpatialApp
+├── __tests__
+├── android
+│   ├── app
+│   └── gradle
+├── ios
+│   ├── SpatialApp
+│   ├── SpatialApp.xcworkspace
+│   ├── SpatialApp.xcodeproj
+│   └── SpatialAppTests
+├── visionos
+│   ├── SpatialApp
+│   ├── SpatialApp.xcodeproj
+│   ├── SpatialApp.xcworkspace
+│   └── SpatialAppTests
+├── node_modules
+└── src
+```

docs/docs/getting-started/entry-point.md

@@ -0,0 +1,7 @@
+{
+  "label": "Guides",
+  "position": 2,
+  "link": {
+    "type": "generated-index"
+  },
+}