Getting Started

Choose Your Setup Path

start

Explore hosted docs

Use the docs site to learn the RIA Hub vocabulary and workflow before touching local tools.

Best when you are reviewing concepts or preparing for a guided walkthrough.

develop

Run locally

Clone the docs or product repo, install dependencies, and validate changes before opening a PR.

Best for docs authors, component work, and source-referenced guide updates.

operate

Use an existing instance

Follow an admin-provided RIA Hub URL, repository, and runner profile.

Best when your team already has data, runners, and packaging targets configured.

Git LFS Baseline

RIA Hub repositories can contain recordings, datasets, exported models, and packaging artifacts. Git LFS keeps those large files manageable while the normal Git history tracks pointers and metadata.

Install and confirm Git LFS

Install Git LFS

Use your platform package manager or the official Git LFS installer, then run git lfs install once for your user.

Clone after installation

Install LFS before cloning repositories that already contain RF data so the large objects are fetched correctly.

Check tracked files

Run git lfs ls-files in the repository to confirm recordings or artifacts are tracked by LFS.

terminal Clone and run docs locally

$ git clone https://github.com/qoherent/riahub-docs.git
cd riahub-docs
npm install
npm run dev

Astro serves the docs at http://localhost:4321