Skip to main content
Loom Core docs

Current Status First

Loom Core Documentation Hub

This is the main docs index for users, contributors, and operators.

Current Status First

If you need to know what is shipped vs still in progress:

  • docs/IMPLEMENTATION_STATUS.md
  • ROADMAP.md

Quick Paths By Audience

  • New user/operator setup: docs/USER_GUIDE.md
  • Contributor/developer workflows: docs/DEVELOPER_GUIDE.md
  • Runtime/system model: docs/ARCHITECTURE.md

Task-Based Navigation

  • Install, sync configs, run daemon/HUD: docs/USER_GUIDE.md
  • Build/reload loop for local development: docs/DEV_BUILD_LIFECYCLE.md
  • Add/update MCP servers safely: docs/DEVELOPER_GUIDE.md
  • Understand compatibility commitments: docs/API_STABILITY.md
  • Follow MCP error-handling standards: docs/ERROR_HANDLING.md
  • Configure enterprise controls: docs/ENTERPRISE_SECURITY.md
  • Configure remote transport (Streamable HTTP): docs/STREAMABLE_HTTP.md
  • Mobile companion API contract (draft): docs/MOBILE_COMPANION_API.md
  • Mobile companion security model (draft): docs/MOBILE_COMPANION_SECURITY.md
  • Mobile companion iPhone test runbook: docs/MOBILE_COMPANION_IPHONE_TESTING.md
  • Mobile companion signing + CI secrets setup: docs/MOBILE_COMPANION_SIGNING_SETUP.md
  • Follow docs ownership and update cadence: docs/DOCS_MAINTENANCE.md
  • Publish docs to flexinfer.ai: docs/FLEXINFER_SITE_INTEGRATION.md

Planning and Technical Direction

  • Active roadmap and priorities: ROADMAP.md
  • Planning index and historical notes: docs/planning/README.md

Diagrams

  • Diagram sources and regeneration notes: docs/diagrams/README.md

Suggested Reading Order

  1. README.md
  2. docs/IMPLEMENTATION_STATUS.md
  3. docs/USER_GUIDE.md
  4. docs/ARCHITECTURE.md
  5. docs/DEVELOPER_GUIDE.md