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://arena.conix.io.

• TODO: Write the docs.
• TODO: Configure html-proofer correctly.

• Install Jekyll
• Install any new ruby packages: make install
• Dependencies: make update
• Build and test: make serve
• Preview site at http://localhost:4000/.

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 for navigation. The navigation details are determined by our theme. See the ARENA-modified just-the-docs theme for more details about site navigation.

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.

Look for broken links and correct HTML using html-proofer:

make check

If you really need to comment out your text, it's not supported, but you can hack it this way:

[//]: # (comment)

Callout alerts are available. Use this syntax:

{% include alert type="warning" title="Coming Soon" content="Stay tuned for more details..." %}

• heading
• info
• tip
• warning
• danger

• ARENA-core

  • https://github.com/conix-center/ARENA-core

• ARENA-py Python examples

  • https://github.com/conix-center/ARENA-py

• ARENA Runtime Supervisor (ARTS)

  • https://github.com/conix-center/arts

• ATLAS

  • https://github.com/conix-center/ATLAS

• ARENA persist

  • https://github.com/conix-center/arena-persist

• ARENA Authentication backend

  • https://github.com/conix-center/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 (some out of date?)

  • JSON message format
  • PubSub topics
  • Runtime notes
  • Refactor
  • Capability-based Access Control
  • Cantrips (pre-ATLAS?)