Where to Find LoopX Documentation: A Complete Guide to Guides, API References, and Architecture Docs

LoopX documentation lives primarily in the docs/ directory of the huangruiteng/loopx repository, with a fully rendered online portal available at https://huangruiteng.github.io/loopx/docs/.

The LoopX project ships a self-contained, bilingual documentation suite designed for both newcomers and advanced contributors. Whether you need quick installation steps, deep architectural context, or operational playbooks, all authoritative sources reside in version-controlled markdown within the repository itself.

---

Documentation Locations: Repository vs. Online Portal

LoopX offers two equivalent paths to access its documentation:

Location	Format	Best For
GitHub repository	Raw markdown files	Power users who prefer local search, version history, or offline reading
Hosted docs site	Rendered HTML with search	Browsing, quick linking, and reading on mobile

The source of truth is always the repository. The online portal at https://huangruiteng.github.io/loopx/docs/ mirrors the markdown structure with improved navigation and styling.

---

Core Documentation Files and Their Purpose

docs/README.md — The Master Index

Start here for the complete map of available documentation at huangruiteng/loopx. This file enumerates every top-level category and provides deep links into guides, reference material, and showcases.

docs/guides/getting-started.md — First-Time Setup

Contains the canonical installation flow, project connection steps, and daily workflow commands. This is where you'll find the quick install one-liner and loopx doctor verification procedure.

docs/architecture.md — System Design

Explains LoopX's kernel architecture, capability layer, and projection surfaces. Essential reading for anyone building extensions or custom runtimes.

docs/state-interaction-model.md — Actor and Store Contracts

Details the interaction model between actors, stores, and the control plane. Referenced when debugging state synchronization issues or implementing new capability providers.

---

Documentation Organization by Use Case

For New Users: Installation and First Steps

The Getting Started Guide at docs/guides/getting-started.md covers:

1. One-line installation via curl
2. PATH configuration for ~/.local/bin
3. loopx connect for project binding
4. loopx status for goal inspection

# Quick install (no clone required)

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

# Verify and connect

loopx doctor
cd /path/to/your/project
loopx connect

For Runtime Integrators: Product Surfaces

The docs/product/ directory documents all supported interfaces:

• Codex CLI — docs/product/runtimes/codex-cli/loopx-turn-codex-cli-quickstart.md
• Claude Code and custom runtimes
• Worker-bridge adapters for external orchestration

The Codex CLI quick-start demonstrates the standard interaction pattern:

loopx codex-cli-bootstrap-message
loopx todo claim
loopx todo update
loopx quota spend-slot

For Capability Developers: Built-in and Custom Capabilities

Capability definitions reside in docs/capabilities/. Each capability folder includes:

• Purpose and behavior specification
• Lark presentation mappings
• Command-line inspection examples

# Explore a capability's interface

loopx capability list
loopx capability show explore

The Explore capability at docs/capabilities/explore/README.md serves as the reference implementation.

For Operators: Governance and Policies

Operations documentation in docs/operations/ governs:

• Quota allocation and slot spending
• Long-task cadence and attention queues
• PR-issue labeling conventions and merge policies

---

Developer Book and Bilingual Resources

LoopX maintains a Developer Book covering control-plane foundations, contribution workflows, and advanced extension topics. This resource is bilingual (English and Chinese) and linked from the badge in docs/guides/getting-started.md.

The book targets contributors who need to understand:

• Host-command registry mechanics
• Reward-memory architecture
• Extension lifecycle protocols

---

Showcases and Real-World Evidence

The docs/showcases/ directory contains curated case studies with public-safe evidence. These demonstrate production deployments of LoopX capabilities without exposing sensitive implementation details.

---

Summary

• Primary documentation repository: https://github.com/huangruiteng/loopx/tree/main/docs/
• Online rendered portal: https://huangruiteng.github.io/loopx/docs/
• Entry point for new users: docs/guides/getting-started.md
• Architectural deep-dives: docs/architecture.md and docs/state-interaction-model.md
• Runtime integration guides: docs/product/runtimes/
• Operational policies: docs/operations/README.md

All documentation is markdown-based, version-controlled, and searchable both on GitHub and through the hosted site.

---

Frequently Asked Questions

Where is the LoopX documentation hosted?

The documentation is hosted in two places: the source markdown files in the docs/ directory of the huangruiteng/loopx GitHub repository, and a rendered HTML version at https://huangruiteng.github.io/loopx/docs/. Both sources are identical in content; the hosted version simply provides better navigation and search.

Is there a quick-start guide for first-time LoopX users?

Yes. The docs/guides/getting-started.md file contains a step-by-step guide including the one-line installation command, PATH setup, project connection via loopx connect, and verification with loopx doctor. This is the recommended starting point for all new users.

What documentation exists for LoopX's internal architecture?

Architectural documentation spans docs/architecture.md for high-level system design and docs/state-interaction-model.md for detailed actor-store interaction contracts. These files explain the kernel, capability layer, projection surfaces, and extension points.

Where can I find information about specific capabilities like "explore"?

Capability-specific documentation lives in docs/capabilities/<name>/README.md. For example, the Explore capability is documented at docs/capabilities/explore/README.md with its Lark presentation mapping and CLI inspection commands.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}