# WallRun

> WallRun is an open-source React workspace for building digital signage as software, with signage-oriented UI components, BrightSign deployment workflows, installable skills, and public documentation for developers.

Use this file as the curated index for the main public WallRun docs surfaces. Treat it as the map, not the payload.

Important notes:

- `wallrun.dev` currently serves a static SPA for humans and static `.md` / `.txt` files for machines.
- For agents and fetch-based tools, prefer the static payloads below because they return `HTTP 200` without SPA route recovery.
- Storybook and the published shadcn registry are hosted separately from the main `wallrun.dev` docs shell.

## Primary AI-Readable Docs

- [Library Overview](https://wallrun.dev/library.md): high-level library map, registry workflow, and doc surface overview.
- [Component Catalogue](https://wallrun.dev/components.md): installable signage component catalogue with install commands, fit guidance, dependencies, and source paths.
- [Full Project Context](https://wallrun.dev/ai-context.md): project summary, hosting model, docs map, and machine-interface guidance.

## Human Docs (Fetch-Safe Browser Routes)

- [Home](https://wallrun.dev/): product overview, positioning, and links into the docs surfaces.
- [Getting Started](https://wallrun.dev/?/getting-started): first-stop setup guidance, including adding signage components to an existing React app.
- [Tooling And Deployment](https://wallrun.dev/?/tooling): player app scaffolding, BrightSign packaging, deployment, discovery, and MCP tooling.
- [Skills](https://wallrun.dev/?/skills): catalog of installable signage-oriented skills.
- [Gallery](https://wallrun.dev/?/gallery): example signage screens and demo compositions.

These are still the human-facing React docs routes, but the `/?/...` form is listed here because it is the fetch-safe version on the current GitHub Pages deployment.

## Human Component Surfaces (Fetch-Safe Browser Routes)

- [Component Library Overview](https://wallrun.dev/?/library): high-level explanation of the WallRun component libraries, registry workflow, and Storybook entry point.
- [Signage Components Reference](https://wallrun.dev/?/components): overview of primitives, layouts, blocks, and behaviour components.
- [Color Palette](https://wallrun.dev/?/color-palette): WallRun demo-site palette and contrast guidance.

## Install And Reference

- [Published Registry JSON](https://wallrun.dev/registry/registry.json): shadcn-compatible registry source for installing WallRun signage components.
- [Storybook Introduction](https://cambridgemonorail.github.io/WallRun/storybook/?path=/docs/introduction--documentation): interactive component and composition docs.
- [Storybook Getting Started](https://cambridgemonorail.github.io/WallRun/storybook/?path=/docs/getting-started--documentation): Storybook install guidance and next-step docs.

## Source And Maintenance

- [GitHub Repository](https://github.com/CambridgeMonorail/WallRun): source code, issues, and contribution entry point.
- [Registry Maintenance Guide](https://github.com/CambridgeMonorail/WallRun/blob/main/docs/guides/registry-maintenance.md): maintainer docs for the published registry.

## Optional

- [Storybook Resources](https://cambridgemonorail.github.io/WallRun/storybook/?path=/docs/resources--documentation): supporting links for Storybook consumers.
- [Sitemap](https://wallrun.dev/sitemap.xml): full XML URL inventory for the public site.