player-ui · hborawski · Oct 28, 2022 · Oct 26, 2022 · Oct 28, 2022 · Oct 28, 2022
@@ -8,9 +8,15 @@ For small bug-fixes, documentation updates, or other trivial changes, feel free
 
 If the changes are larger (API design, architecture, etc), [opening an issue](https://github.com/player-ui/player/issues/new/choose) can be helpful to reduce implementation churn as we hash out the design.
 
-## Building and Testing Locally
+## Requirements
+* [npm >= 8.19.2](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
+* [yarn >= 1.22.19](https://yarnpkg.com/)
+* [Swift >= 5.2](https://www.swift.org/download/)
+* [Android NDK >= 19.2.5345600, <= 21](https://github.com/android/ndk/wiki/Unsupported-Downloads#r19c). Any version > 21 will not work, period. You'll need to add `ANDROID_NDK_HOME` to your environment manually.
 
-For speed and consistency, this repo leverages `bazel` as it's main build tool.
+## Building and Testing Locally
+### Player
+For speed and consistency, this repo leverages `bazel` as it's main build tool. Check out the [bazel](https://bazel.build/) docs for more info.
 
 After forking the repo, run builds using:
 
@@ -23,7 +29,16 @@ Tests can also be ran using:
 ```bash
 bazel test //...
 ```
-Check out the [bazel](https://bazel.build/) docs for more info.
+
+### Docs Sites
+These require the [Android NDK](https://developer.android.com/ndk).
+The docs site can be ran using:
+
+```bash
+bazel build //docs/site:start
+bazel run //docs/site:start
+```
+which will run an instance on `http://localhost:3000`.
 
 
 ## Submitting a Pull Request

@@ -101,10 +101,6 @@ const PlatformTabs = (props: React.PropsWithChildren<unknown>) => {
     CodeTabsNameMap.has(c.props.mdxType.toLowerCase())
   );
 
-  if (!router.isReady) {
-    return <Progress isIndeterminate size="xs" />;
-  }
-
   const langPrefIndex = children.findIndex(
     (c: any) => c.props.mdxType.toLowerCase() === router.query.lang
   );

@@ -45,7 +45,7 @@ The `id` of the views are used in the navigation section to reference a specific
 
 ## Cross-field validation
 
-The other special property of a `view` vs. an `asset` is the addition of a `validation` property on the view. These contains [`validation` objects](../guides/validation) that are used for validations crossing multiple fields, and are ran on user navigation rather than data change.
+The other special property of a `view` vs. an `asset` is the addition of a `validation` property on the view. These contain [`validation` objects](/schema) that are used for validations crossing multiple fields, and are ran on user navigation rather than data change.
 
 Example:
 

@@ -126,7 +126,7 @@ State types can also contain `onStart` and `onEnd` properties for evaluating exp
 
 This is the simplest of flows. The navigation begins with executing `FLOW_1`. `FLOW_1` begins with the `VIEW_1` state. `VIEW_1` shows the view with id `view-1`, and any transition from that view goes to `END_1` which completes Player's execution with the `Done` outcome.
 
-![Single Flow Example](https://mockimages.s3-us-west-2.amazonaws.com/docs/simple-flow.png)
+![Single Flow Example](/simple-flow.png?darkModeInvert)
 
 ### Flow with `onStart` expression
 

@@ -2,11 +2,8 @@ import { Meta } from '@storybook/addon-docs';
 
 <Meta title="Welcome" />
 
-<div style={{ display: 'flex', justifyContent: 'center'}}>
-  <img src="https://ibp-cicd-core.prod1-ibp.a.intuit.com/player/media/latest/logo/large-light.png" alt-text="Player Logo" />
-</div>
-
-<br />
+![Player Logo](/logo/logo-light-large.png?lightModeOnly)
+![Player Logo](/logo/logo-light-large.png?darkModeOnly)
 
 Player is a framework for building cross-platform experiences. The main engine is written in Typescript, with platform specific adapters for iOS, Android, and React (web). It's built from the ground up with plugins in mind to perfectly tailor the experience specifically for your app.