jekyll build from Action d826147

CNAME

@@ -0,0 +1 @@
+docs.arenaxr.org

CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# Contribution Guide
+
+The Contribution Guide for all ARENA projects can be found [here](https://docs.arenaxr.org/content/contributing.html).

LICENSE

@@ -0,0 +1,2 @@
+This work is licensed under a Creative Commons Attribution 4.0 International License.
+https://creativecommons.org/licenses/by/4.0/legalcode

Makefile

@@ -0,0 +1,37 @@
+SHELL := /bin/bash
+BUNDLE := bundle
+JEKYLL := $(BUNDLE) exec jekyll
+HTMLPROOF := $(BUNDLE) exec htmlproofer
+PROJECT_DEPS := Gemfile
+
+.PHONY: all check install update build serve
+
+all: install serve
+
+check:
+	$(JEKYLL) doctor
+	$(HTMLPROOF) --check-html \
+		--http-status-ignore 999,403,429 \
+		--assume-extension \
+		--allow-hash-href \
+		--check-favicon \
+		--empty-alt-ignore \
+		_site
+
+install: $(PROJECT_DEPS)
+	$(BUNDLE) install --path _vendor/bundle
+
+update: $(PROJECT_DEPS)
+	$(BUNDLE) update
+
+build:
+	$(JEKYLL) build
+
+serve:
+	$(JEKYLL) serve
+
+watch:
+	$(JEKYLL) serve --watch
+
+clean:
+	$(JEKYLL) clean

README.md

@@ -0,0 +1,84 @@
+# ARENA Documentation Website
+
+This is the ARENA Documentation website giving architecture, APIs, and step-by-step instructions to use the ARENA project. This is a static site generated by Jekyll, and is deployed on push to [https://docs.arenaxr.org](https://docs.arenaxr.org).
+
+## Local Development
+* [Install Jekyll](https://jekyllrb.com/docs/installation)
+* Install any new ruby packages: `make install`
+* Dependencies: `make update`
+* Build and test: `make serve`
+* Clean build: `make clean`
+* Check html: `make check`
+* Preview site at [http://localhost:4000/](http://localhost:4000/).
+
+## Content
+
+ARENA Documentation pages are written in markdown and placed in the `content` directory, except for `./index.md`.
+
+Each `.md` file inside `content` must have [YAML Front Matter](https://jekyllrb.com/docs/front-matter) for navigation. The navigation details are determined by our theme. See the [just-the-docs](https://github.com/just-the-docs/just-the-docs/blob/main/docs/navigation-structure.md) theme for more details about site navigation.
+
+## Test
+
+```shell
+make serve
+```
+
+This will create a watcher that will update and regenerate the localhost test site and allow you to immediately preview changes formatted to HTML.
+
+The newly generated website will be placed in the `_site` directory.
+
+## Check HTML and Links
+
+Look for broken links and correct HTML using [html-proofer](https://github.com/gjtorikian/html-proofer):
+
+```shell
+make check
+```
+
+## Alerts/Callouts
+Callout alerts are available. Use this syntax:
+```markdown
+{% include alert type="warning" title="Coming Soon" content="Stay tuned for more details..." %}
+```
+- heading
+- info
+- tip
+- warning
+- danger
+
+# ARENA-Related Repositories
+
+- **ARENA-web-core**
+  - https://github.com/arenaxr/arena-web-core
+
+- **arena-py Python examples**
+  - https://github.com/arenaxr/arena-py
+
+- **arena-unity Unity library**
+  - https://github.com/arenaxr/arena-unity
+
+- **ARENA Runtime Supervisor (ARTS)**
+  - https://github.com/SilverLineFramework/orchestrator
+
+- **ATLAS**
+  - https://github.com/arenaxr/ATLAS
+
+- **ARENA persist**
+  - https://github.com/arenaxr/arena-persist
+
+- **ARENA Authentication backend**
+  - https://github.com/arenaxr/arena-account
+
+- **Posefusion**
+  - https://github.com/conix-center/posefusion
+
+- **April Tag Decoding w. AR.js**
+  - https://github.com/conix-center/AR.js/blob/master/README.md#apriltag-detection
+
+- **[Original Design Notes slides](https://docs.google.com/presentation/d/1dc1RdlGROBYj1zIoPR8HX_RBIKn8-KRmNZscXVrdIs0/edit?ts=5dbc423f#slide=id.g606e93cce1_1_14)** (some out of date?)
+  - JSON message format
+  - PubSub topics
+  - Runtime notes
+  - Refactor
+  - Capability-based Access Control
+  - Cantrips (pre-ATLAS?)