Skip to content
This repository has been archived by the owner on Feb 19, 2019. It is now read-only.

Major docs update #102

Merged
merged 42 commits into from
Oct 18, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
483a9fd
change tech integrations column to web or native api
chrislatorres Oct 17, 2018
85c529d
consolidate redundant running app guides
chrislatorres Oct 17, 2018
5e9286c
update sidebar doc locations
chrislatorres Oct 17, 2018
4432e96
update running an app video tag format
chrislatorres Oct 17, 2018
c1ca7cb
add legal link to footer
chrislatorres Oct 17, 2018
9b10f89
move legal docs to seperate section
chrislatorres Oct 17, 2018
1c204ea
change MLSDK to Magic Leap SDK
chrislatorres Oct 17, 2018
8a6dae1
move exokit apps location in sidebar
chrislatorres Oct 17, 2018
48039a3
remove command line flags doc
chrislatorres Oct 17, 2018
c54bb82
add command line flags doc
chrislatorres Oct 17, 2018
a354132
remove start here doc, move to landing page
chrislatorres Oct 17, 2018
bd7371f
add pattern images
chrislatorres Oct 18, 2018
ad1bc6c
create seperate webAPIs doc
chrislatorres Oct 18, 2018
517270b
rename privacy and support docs
chrislatorres Oct 18, 2018
0e3d1ca
rename support doc
chrislatorres Oct 18, 2018
beccdf7
rename landingsdk to sdk
chrislatorres Oct 18, 2018
6c5aef3
rename futureintegrations to nativefutureintegrations
chrislatorres Oct 18, 2018
621cba9
add seperate nativeAPIs doc
chrislatorres Oct 18, 2018
0e4f4a2
rename betaAPIs to experimentalWebAPIs
chrislatorres Oct 18, 2018
fd0a260
rename exokit command line doc
chrislatorres Oct 18, 2018
8427f87
reformat landing page css, reduce navbar size
chrislatorres Oct 18, 2018
ad19d02
change sdk path in siteConfig nav link
chrislatorres Oct 18, 2018
2677184
reorg sidebar and update doc names
chrislatorres Oct 18, 2018
3181d17
major work on landing page
chrislatorres Oct 18, 2018
6e64eec
change terms link path in footer
chrislatorres Oct 18, 2018
82fe06d
update startdevelopment titles
chrislatorres Oct 18, 2018
b3511e9
grammar fix in installation doc
chrislatorres Oct 18, 2018
6308e0d
grammar fix exokitengine doc
chrislatorres Oct 18, 2018
69158ad
change command line flags sidebar title
chrislatorres Oct 18, 2018
6fae8e6
title and grammar fix in contribute doc
chrislatorres Oct 18, 2018
15acb51
clean up old/redundant files
chrislatorres Oct 18, 2018
9488fa0
update help nav bar link path
chrislatorres Oct 18, 2018
7cb733d
fix typo
chrislatorres Oct 18, 2018
43a936c
cleanup placeholder pics
chrislatorres Oct 18, 2018
7dc8a50
adjust landing page styling
chrislatorres Oct 18, 2018
0ff3011
remove placeholder pics in docs
chrislatorres Oct 18, 2018
56e8e74
add coming soon to guide
chrislatorres Oct 18, 2018
54dffd6
add landing page img files
chrislatorres Oct 18, 2018
b3d0e87
re-add features, change name of new features, comment out old features
chrislatorres Oct 18, 2018
f50f97a
update expanse transparent img
chrislatorres Oct 18, 2018
f4df929
update activetheory transparent img
chrislatorres Oct 18, 2018
4de8b15
update siteconfig img paths
chrislatorres Oct 18, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/MagicLeapAPI.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: MagicLeapAPI
id: MagicLeapAPI
title: Magic Leap API
sidebar_label: Magic Leap API
---
Expand Down
10 changes: 5 additions & 5 deletions docs/contribute.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
id: contribute
title: How to Contribute
sidebar_label: How to Contribute
title: How to Contribute
sidebar_label: Contribute
---


### If you know code:

* If you know JS: Either dive into the code ("the browser is a site"), pick up an issue marked [good first issue](https://github.com/webmixedreality/exokit/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22), or [ask us](community.md).
* If you know JS: Either dive into the code ("the browser is a site"), pick up an issue marked [good first issue](https://github.com/webmixedreality/exokit/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22), or [ask us](support.md).

### If you dont know code:
### If you don't know code:

* For non-code contributions: File a good bug report with a repro for your site, or tell us about your use case that you'd like to work (filing an issue on the [github](https://github.com/webmixedreality/exokit) is a great way to do that).
* For non-code contributions: File a good bug report with information to reproduce the bug for your site, or tell us about your use case that you'd like to work (filing an issue on the [GitHub](https://github.com/webmixedreality/exokit/issues/new) is a great way to do that).
8 changes: 2 additions & 6 deletions docs/devExokitEngine.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,5 @@ title: My First Exokit App
sidebar_label: My First Exokit App
---

## Clone the Exokit Engine Repository
Check out our [Quickstart section](startDevelopment.md) for developers to learn how to clone our repository.

# Common Commands & Flags
# Components
# Beta API
## Guide coming soon!
##### Until then, join our [Slack](https://join.slack.com/t/exokit/shared_invite/enQtNDI3NjcxNzYwMDIxLWU2NmFmOTEzMzk4NWNiYjRhMjVkYzcyNjg5YjUyMzZkYWM1ZGI4M2IwYWZiMjNlMTJjMDlkM2U3Y2JiNTc2M2Q) and [Discord](https://discord.gg/cf5tfTV) to chat and ask questions.
4 changes: 2 additions & 2 deletions docs/CommandLine.md → docs/exokitCommandLine.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: CommandLine
title: Exokit Command Line
id: exokitCommandLine
title: Launch using Exokit Command Line
sidebar_label: Exokit Command Line
---

Expand Down
6 changes: 3 additions & 3 deletions docs/Flags.md → docs/exokitCommandLineFlags.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: Flags
title: Command Line Flags
sidebar_label: Command Line Flags
id: exokitCommandLineFlags
title: Exokit Command Line Flags
sidebar_label: Exokit Command Line Flags
---

An example of how to use these flags:
Expand Down
4 changes: 2 additions & 2 deletions docs/exokitEngine.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Since Exokit supports anything that runs on the web, it powers experiences built

Yes.

We use an npm module for HTML parsing, then resurrected an old OpenGL binding from Github, took WebAudio extracted out of Chrome, and so on. We glued it together and wrote a custom binding for the HTML and Javascript that powers your web site.
We use an npm module for HTML parsing, then resurrected an old OpenGL binding from GitHub, took WebAudio extracted out of Chrome, and so on. We glued it together and wrote a custom binding for the HTML and Javascript that powers your web site.

# What platforms are supported?

Expand All @@ -88,4 +88,4 @@ Since Exokit supports anything that runs on the web, it powers experiences built

# Can I use it?

Sure! It's [open source on Github](https://github.com/webmixedreality/exokit). You can also embed it since [it's a node module](https://github.com/webmixedreality/exokit/blob/master/package.json).
Sure! It's [open source on GitHub](https://github.com/webmixedreality/exokit). You can also embed it since [it's a node module](https://github.com/webmixedreality/exokit/blob/master/package.json).
8 changes: 4 additions & 4 deletions docs/BetaAPIs.md → docs/experimentalWebAPIs.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
id: BetaAPIs
title: Beta APIs
sidebar_label: Beta APIs
id: experimentalWebAPIs
title: Experimental Web APIs
sidebar_label: Experimental
---

## XRMultiplayer

XRMultiplayer is an experimental API and protocol for multi-user presence that compliments WebXR. It is a client-server protocol for lightweight sharing of user "parties" and scenes.

For more info, you can read the code on the [webmixedreality/xrmp](https://github.com/webmixedreality/xrmp) Github repository.
For more info, you can read the code on the [webmixedreality/xrmp](https://github.com/webmixedreality/xrmp) GitHub repository.
8 changes: 4 additions & 4 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ MacOS Gatekeeper sometimes blocks new apps from running. To get around that, you

## Linux notes

You'll [need additional libraries installed](https://docs.webmr.io/docs/startDevelopment.html#linux-dependencies) for the Linux build to run.
You'll [need additional libraries installed](startDevelopment.html#linux-dependencies) for the Linux build to run.

## Alternate releases

[Github Releases](https://github.com/webmixedreality/exokit/releases) has every alternate and past release.
[GitHub Releases](https://github.com/webmixedreality/exokit/releases) has every alternate and past release.

> The Exokit installer just grabs the latest release from Github.
> The Exokit installer just grabs the latest release from GitHub.

The releases are built on every version update of the [Github repository](https://github.com/webmixedreality/exokit).
The releases are automatically built on every version update of the [GitHub repository](https://github.com/webmixedreality/exokit).
12 changes: 6 additions & 6 deletions docs/Integrations.md → docs/nativeAPIs.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: Integrations
title: Native Integrations
sidebar_label: Native Integrations
id: nativeAPIs
title: Native APIs
sidebar_label: Overview
---

## WebGL
Expand All @@ -19,7 +19,7 @@ The Web Audio API provides a powerful and versatile system for controlling audio
## WebRTC

WebRTC (Web Real-Time Communications) is a technology which enables Web applications and sites to capture and optionally stream audio and/or video media, as well as to exchange arbitrary data between browsers without requiring an intermediary.

The set of standards that comprises WebRTC makes it possible to share data and perform teleconferencing peer-to-peer, without requiring that the user install plug-ins or any other third-party software.

WebRTC consists of several interrelated APIs and protocols which work together to achieve this. The documentation you'll find here will help you understand the fundamentals of WebRTC, how to set up and use both data and media connections, and more.
Expand All @@ -34,15 +34,15 @@ Node is the foundation of all that runs our JS, kind of our sturdiest foundation
The OpenVR API provides a game with a way to interact with Virtual Reality displays without relying on a specific hardware vendor's SDK. It can be updated independently of the game to add support for new hardware or software updates.

The API is implemented as a set of C++ interface classes full of pure virtual functions. When an application initializes the system it will return the interface that matches the header in the SDK used by that application.

Once a version of an interface is published, it will be supported in all future versions, so the application will not need to update to a new SDK to move forward to new hardware and other features.

## Other Integrations

- OVR
- Oculus
- MLSDK
- Magic Leap
- Magic Leap
- Leap Motion
- Leap motion hand tracking
- Chromium
Expand Down
16 changes: 8 additions & 8 deletions docs/FutureIntegrations.md → docs/nativeFutureIntegrations.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
---
id: FutureIntegrations
title: Future Integrations
id: nativeFutureIntegrations
title: Native Future Integrations
sidebar_label: Future Integrations
---


As it stands, the current objectives for what we hope to integrate going forward are the following:

## Unity

Exokit engine is a Node.js module, so it's relatively straightforward to add native bindings to other engines like Unity, in either direction. If you have a use case you'd like supported here, let us know.

## Electron
We often get asked how to use Exokit on top of an existing Electron app to power the WebGL/WebXR parts. This needs to be documented.

## Ethereum
This is another thing that we've experimented with for a while, and we're interested in the blockchain possibility. While we don't want Exokit to become a vehicle for token speculation, we think there could be a place for some sort of subscription model or notion of app ownership in alliance with Cryptocurrency use. This isn't strictly about Ethereum but blockchains in general.

## ARCore + ARKit
We would love to have the Exokit Engine core run on these, taking in matrices from the phone and working with any WebXR/Exokit content is a big step to take and we are all about it. We've run experiments with both so far so its definitely in the cards.
We would love to have the Exokit Engine core run on these, taking in matrices from the phone and working with any WebXR/Exokit content is a big step to take and we are all about it. We've run experiments with both so far so its definitely in the cards.

ARCore is much easier than ARKit because Apple isn't very flexible here (no dynarec, no V8). But either way this would not be a new Exokit Engine, it would be the same Exokit Engine so whatever content runs today would just auto-magically run on the phone. Like tabletop Emukit, this also applies to Daydream/VR for these devices.

* And most recently, with our newest addition of Emukit (our VR-based Console Emulator), we hope to support consoles and emulators as well.

To see a list of our current integrations, check out our [Tech Stack](techIntegrations.md)
16 changes: 8 additions & 8 deletions docs/ExokitPrivacy.md → docs/privacy.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: ExokitPrivacy
id: privacy
title: Exokit Products Privacy Policy
sidebar_label: Privacy Policy
---
Expand All @@ -11,21 +11,21 @@ This privacy policy discloses the privacy practices for Exokit products. This pr
3. The security procedures in place to protect the misuse of your information.
4. How you can correct any inaccuracies in the information.

## Information Collection, Use, and Sharing
## Information Collection, Use, and Sharing
We are the sole owners of the information collected on Exokit products. We only have access to/collect information that you voluntarily give us via sign-up or other direct contact from you. We will not sell or rent this information to anyone.

We track a unique identifier number in product builds to get better insight of how users use Exokit products. We will use your information to respond to you, regarding the reason you contacted us. We will not share your information with any third party outside of our organization, other than as necessary to fulfill your request, e.g. to ship an order.

Unless you ask us not to, we may contact you via email in the future to tell you about specials, new products or services, or changes to this privacy policy.

## Your Access to and Control Over Information
## Your Access to and Control Over Information
You may opt out of any future contacts from us at any time. You can do the following at any time by contacting us via the email address: `hello@webmr.io`

- See what data we have about you, if any.
- Change/correct any data we have about you.
- Have us delete any data we have about you.
- Express any concern you have about our use of your data.
## Security
## Security

We take precautions to protect your information. When you submit sensitive information via Exokit products, your information is protected both online and offline.

Expand All @@ -35,11 +35,11 @@ While we use encryption to protect sensitive information transmitted online, we

If you feel that we are not abiding by this privacy policy, you should contact us immediately via email at: `hello@webmr.io`.

## Registration
In order to use Exokit products, a user must first complete the sign-up form. During registration a user is required to give certain information (card info, email address and password). This information is used to contact you about the products/services on our site in which you have expressed interest. The main purpose of user information taken from registration is to facilitate the payment system and sign-in features.
## Registration
In order to use Exokit products, a user must first complete the sign-up form. During registration a user is required to give certain information (card info, email address and password). This information is used to contact you about the products/services on our site in which you have expressed interest. The main purpose of user information taken from registration is to facilitate the payment system and sign-in features.

## Orders
## Orders
We request information from you on our order form. To buy from us, you must provide contact information (email address) and financial information (like credit card number, expiration date). This information is used for billing purposes and to fill your orders. If we have trouble processing an order, we'll use this information to contact you.

## Links
## Links
Exokit products contain links to other sites. Please be aware that we are not responsible for the content or privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of any other site that collects personally identifiable information.
8 changes: 4 additions & 4 deletions docs/SDKLanding.md → docs/sdk.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: SDKLanding
id: sdk
title: Exokit SDK
sidebar_label: Exokit SDK
sidebar_label: Introduction
---

## SDK Bundle
Expand All @@ -26,7 +26,7 @@ If the site uses [WebXR](https://immersive-web.github.io/webxr/), [WebGL](https:

This means existing web documentation applies to Exokit as well.

**Docs**: [Web APIs](API.md)
**Read more at**: [Web APIs](webAPIs.md)

## Native integrations

Expand All @@ -47,4 +47,4 @@ browserWindow.on('paint', message => {
});
```

**Docs**: [Native integrations](Integrations.md)
**Read more at**: [Native APIs](nativeAPIs.md)
13 changes: 4 additions & 9 deletions docs/startDevelopment.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
---
id: startDevelopment
title: Setting up a Development Environment
sidebar_label: Development
id: startDevelopment
title: Set up a Development Environment
sidebar_label: Set up a Development Environment
---

<img src="http://via.placeholder.com/800x300" alt="Diagram of engine cloned from Github, running on machine with some code view, and machine linked to various devices"/>

The main project repository is at [`webmixedreality/exokit`](https://github.com/webmixedreality/exokit). You can clone it the regular way:

```
Expand Down Expand Up @@ -87,9 +85,8 @@ After the above you should be able to use `chrome://inspect` in the Chrome brows
1. Capture heap snapshots
1. Capture CPU profiles of live sites

#### Example session
<!-- #### Example session -->

<img src="http://via.placeholder.com/800x300" alt="Example gif or video running the above procedure"/>

#### Wait for attach

Expand All @@ -108,5 +105,3 @@ Pull Requests are very much welcome as well.
#### Troubleshooting

- `<SkImage.h> not found`, or a missing header: this means a prebuilt dependency did not extract. Clear your `npm`/`yarn` cache, `rm -Rf node_modules` and `npm install` again.


57 changes: 0 additions & 57 deletions docs/startExokitEngine.md

This file was deleted.

34 changes: 0 additions & 34 deletions docs/startHere.md

This file was deleted.

10 changes: 5 additions & 5 deletions docs/community.md → docs/support.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
id: community
title: Community and Support
sidebar_label: Community and Support
id: support
title: Support
sidebar_label: Support
---

## Github
## GitHub
At our [GitHub repo](https://github.com/webmixedreality/exokit) browse and sumbit [issues](https://github.com/webmixedreality/exokit/issues) or [pull requests](https://github.com/webmixedreality/exokit/pulls) for bugs you find or any new features you may want implemented. Be sure to check out [how to contribute.](${docUrl('contribute.html')})

## Stay Updated
## Stay Updated
We post announcements and updates to our [blog](https://webmr.io/blog).

Follow Exokit on [Twitter](https://twitter.com/webmixedreality).
Expand Down
Loading