> ## Documentation Index
> Fetch the complete documentation index at: https://docs.inklyai.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Architecture and contributing

> How the interactive-demo repo is organised, and where to read before you change it.

`interactive-demo` is MIT licensed and developed in the open at [github.com/inkly-ai/interactive-demo](https://github.com/inkly-ai/interactive-demo). Pull requests are welcome.

The repo is an npm workspace with three packages:

| Package | What it owns |
| - | - |
| `packages/runtime` | The React player, the demo schema, and the theme. Published as `@inkly-org/interactive-demo`. |
| `packages/cli` | The `interactive-demo` command. Published as `@inkly-org/interactive-demo-cli`. |
| `packages/editor` | The local editor. Not published on its own. It is built into the CLI and served by `dev`. |

The contributor documentation lives in the repo, next to the code it describes.

<CardGroup cols={2}>
  <Card title="Architecture" icon="sitemap" href="https://github.com/inkly-ai/interactive-demo/blob/main/docs/architecture.md">
    What each package is responsible for, the build graph, the testbed, and the checks a change has to pass.
  </Card>

  <Card title="Contributing" icon="code-pull-request" href="https://github.com/inkly-ai/interactive-demo/blob/main/CONTRIBUTING.md">
    How to propose a change, the commit style, and the sign-off the project uses.
  </Card>
</CardGroup>

## Run it from source

```sh theme={"dark"}
git clone https://github.com/inkly-ai/interactive-demo.git
cd interactive-demo
npm install
npm run build && npm run typecheck && npm run lint && npm test
```

Found a bug or want a feature? [Open an issue](https://github.com/inkly-ai/interactive-demo/issues).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.