# Where to Find LoopX Documentation: Complete Guide to Guides, API Reference, and Architecture

> Find LoopX documentation easily in the huangruiteng/loopx repository docs directory or at the published static site. Access guides, API reference, and architecture details.

- Repository: [huangruiteng/loopx](https://github.com/huangruiteng/loopx)
- Tags: api-reference
- Published: 2026-08-11

---

**LoopX documentation is located in the `docs/` directory of the huangruiteng/loopx repository and published as a static site at https://huangruiteng.github.io/loopx/docs/.**

The LoopX documentation source lives entirely within the repository under version control, ensuring you always have access to the exact version matching your installation. Whether you prefer browsing markdown files directly in the repository or reading the rendered HTML site, both sources remain synchronized and contain comprehensive guides for installation, architecture, and integration.

## Documentation Locations: Repository vs. Hosted Site

LoopX maintains its documentation in two synchronized locations: the master markdown files in the repository and a publicly hosted static site generated from those same files.

### Repository Source Files

The definitive source of LoopX documentation resides in the **`docs/`** directory at the repository root. This location contains version-controlled markdown files covering guides, reference materials, and architectural specifications. Key entry points include:

- **[`docs/README.md`](https://github.com/huangruiteng/loopx/blob/main/docs/README.md)** — The master index that links to every major section, serving as your starting point for navigation.
- **[`docs/guides/getting-started.md`](https://github.com/huangruiteng/loopx/blob/main/docs/guides/getting-started.md)** — Step-by-step instructions for installation, project connection, and first-run workflows.
- **[`docs/architecture.md`](https://github.com/huangruiteng/loopx/blob/main/docs/architecture.md)** — High-level conceptual diagrams and descriptions of LoopX's control-plane, kernel, and durable state model.
- **[`docs/state-interaction-model.md`](https://github.com/huangruiteng/loopx/blob/main/docs/state-interaction-model.md)** — Formal specifications for how agents, capabilities, and the kernel interact through actors, stores, and contracts.
- **[`docs/integration.md`](https://github.com/huangruiteng/loopx/blob/main/docs/integration.md)** — API contracts and examples for embedding LoopX in custom runtimes or host applications.

### Hosted Documentation Portal

The repository automatically publishes to **https://huangruiteng.github.io/loopx/docs/**, rendering the markdown source as a searchable, browsable website. This hosted version includes:

- A bilingual "Developer Book" at `/docs/book/` providing a curated learning path from fundamentals to advanced topics.
- Mirrors of all files in the `docs/` tree with identical content to the repository source.
- Installation scripts hosted on GitHub Pages for quick setup without cloning.

For the exact version you are working with, always refer to the files in the `main` branch of the repository rather than the hosted site, as the repository represents the source of truth.

## Getting Started Guide and CLI Reference

The **[`docs/guides/getting-started.md`](https://github.com/huangruiteng/loopx/blob/main/docs/guides/getting-started.md)** file provides the primary onboarding path, covering installation via the hosted installer script and initial project configuration.

### Installation Commands

The documentation recommends installing LoopX without cloning the repository using the installer script:

```bash

# Install LoopX using the hosted installer script

curl -fsSL https://huangruiteng.github.io/loopx/install.sh | bash
export PATH="$HOME/.local/bin:$PATH"

# Verify the installation completed successfully

loopx doctor

```

### Project Connection Workflow

After installation, the guide walks through connecting LoopX to an existing project and inspecting state:

```bash

# Connect LoopX to an existing project (run from project root)

loopx connect

# Inspect the current loop state

loopx status

# Start a guided goal if no LoopX state exists yet

loopx start-goal --guided --project . --goal-text "Your long-running objective"

```

### Auto-Research Preset Commands

For multi-agent research workflows, **[`docs/guides/auto-research-command-path.md`](https://github.com/huangruiteng/loopx/blob/main/docs/guides/auto-research-command-path.md)** documents the preset system:

```bash

# List available presets

loopx preset list

# Show the "daily-triage" preset definition

loopx preset show daily-triage

# Activate the preset for the current goal

loopx preset apply daily-triage

```

## Architecture and Technical Reference

Beyond introductory guides, LoopX documentation includes detailed technical specifications for developers extending or embedding the system.

### Core Architecture Documentation

**[`docs/architecture.md`](https://github.com/huangruiteng/loopx/blob/main/docs/architecture.md)** describes LoopX's control-plane concepts, including the kernel, capabilities, extensions, and the durable state model that persists across sessions.

### State Interaction Model

**[`docs/state-interaction-model.md`](https://github.com/huangruiteng/loopx/blob/main/docs/state-interaction-model.md)** provides a formal model of the write-back flow between:
- **Actors** — The running agents and processes.
- **Stores** — Persistence mechanisms for state.
- **Contracts** — Interfaces defining valid interactions.

This document is essential for understanding how LoopX maintains consistency during long-running operations.

### Integration Guide

**[`docs/integration.md`](https://github.com/huangruiteng/loopx/blob/main/docs/integration.md)** covers embedding LoopX in custom runtimes, including:
- The worker-bridge install contract.
- API contracts for host applications.
- Examples for custom runtime integration.

### Update Notes

Version-specific changes and documentation updates are tracked in **[`docs/update-notes/README.md`](https://github.com/huangruiteng/loopx/blob/main/docs/update-notes/README.md)**, providing a changelog-style reference for tracking features by release.

## Summary

- **LoopX documentation** source files live in the `docs/` directory of the huangruiteng/loopx repository, with the entry point at [`docs/README.md`](https://github.com/huangruiteng/loopx/blob/main/docs/README.md).
- The **hosted documentation portal** at https://huangruiteng.github.io/loopx/docs/ renders the same markdown files as a searchable static site.
- **Getting started** instructions are found in [`docs/guides/getting-started.md`](https://github.com/huangruiteng/loopx/blob/main/docs/guides/getting-started.md), including the `curl` installer script and `loopx connect` workflow.
- **Architecture details** covering the control-plane, state model, and integration contracts are documented in [`docs/architecture.md`](https://github.com/huangruiteng/loopx/blob/main/docs/architecture.md), [`docs/state-interaction-model.md`](https://github.com/huangruiteng/loopx/blob/main/docs/state-interaction-model.md), and [`docs/integration.md`](https://github.com/huangruiteng/loopx/blob/main/docs/integration.md).
- **Auto-research presets** for multi-agent workflows are documented in [`docs/guides/auto-research-command-path.md`](https://github.com/huangruiteng/loopx/blob/main/docs/guides/auto-research-command-path.md).

## Frequently Asked Questions

### Is the LoopX documentation available offline?

Yes. Since the documentation resides in the `docs/` directory of the repository as markdown files, you can read it offline by cloning the repository and opening the files in any markdown viewer or text editor. The [`docs/README.md`](https://github.com/huangruiteng/loopx/blob/main/docs/README.md) file serves as the master index for offline navigation.

### How do I find documentation for a specific LoopX version?

Check the [`docs/update-notes/README.md`](https://github.com/huangruiteng/loopx/blob/main/docs/update-notes/README.md) file in the repository, which contains changelog-style notes for each release. For the most accurate documentation matching your installed version, checkout the specific release tag in the repository and browse the `docs/` directory at that commit.

### What is the LoopX Developer Book?

The Developer Book is a curated learning path hosted at https://huangruiteng.github.io/loopx/docs/book/ that structures LoopX documentation into a progressive curriculum. It covers foundations, capabilities, and operations in a bilingual format designed for developers learning the system from first principles.

### Where are the LoopX CLI commands documented?

CLI commands are documented in [`docs/guides/getting-started.md`](https://github.com/huangruiteng/loopx/blob/main/docs/guides/getting-started.md) for basic operations like `loopx connect` and `loopx status`, and in [`docs/guides/auto-research-command-path.md`](https://github.com/huangruiteng/loopx/blob/main/docs/guides/auto-research-command-path.md) for preset commands like `loopx preset list` and `loopx preset apply`. These files contain the authoritative reference for command syntax and usage examples.