Skip to content

Latest commit

 

History

History
136 lines (101 loc) · 5.07 KB

README.md

File metadata and controls

136 lines (101 loc) · 5.07 KB

Loopi Documentation Index

Welcome to Loopi documentation! This folder contains comprehensive guides for users and developers.

📖 Start Here

New to Loopi? → Read GETTING_STARTED.md

Want to understand the documentation structure? → Read DOCUMENTATION_MAP.md

📚 All Documents

For Users

For Developers

Reference

🎯 Quick Links by Task

I want to... Read...
Get started with Loopi GETTING_STARTED.md
Learn about variables VARIABLES.md
Look up a step type STEPS_REFERENCE.md
Understand the system ARCHITECTURE.md
Add a new step NEW_STEP_TEMPLATE.md
Modify a component COMPONENT_GUIDE.md
Do common dev tasks DEVELOPMENT_WORKFLOWS.md
Maintain documentation DOCUMENTATION_GUIDE.md
Find what to read DOCUMENTATION_MAP.md

📁 Document Organization

docs/
├── README.md (you are here)
├── DOCUMENTATION_MAP.md          ← Navigation guide, start here for structure
│
├── User Guides
│   ├── GETTING_STARTED.md         ← Installation & first automation
│   ├── VARIABLES.md               ← Variable system guide
│   ├── STEPS_REFERENCE.md         ← All step types with examples
│   └── examples/                  ← Real-world automation examples
│
├── Developer Guides
│   ├── ARCHITECTURE.md            ← System design & internals
│   ├── COMPONENT_GUIDE.md         ← React components & patterns
│   ├── DEVELOPMENT_WORKFLOWS.md   ← Common dev tasks
│   ├── NEW_STEP_TEMPLATE.md       ← Adding new steps
│   └── DOCUMENTATION_GUIDE.md     ← Maintaining documentation

🚀 Common Workflows

Building Your First Automation

  1. GETTING_STARTED.md - Install Loopi
  2. GETTING_STARTED.md - 5-step tutorial
  3. VARIABLES.md - Learn variables (as needed)
  4. STEPS_REFERENCE.md - Look up step types

Adding a New Feature

  1. ARCHITECTURE.md - Understand the system
  2. NEW_STEP_TEMPLATE.md - Follow the checklist
  3. COMPONENT_GUIDE.md - Component patterns (if UI)
  4. DOCUMENTATION_GUIDE.md - Update docs

Fixing a Bug

  1. ARCHITECTURE.md - Understand data flow
  2. DEVELOPMENT_WORKFLOWS.md - Debugging process
  3. DOCUMENTATION_GUIDE.md - Update docs if behavior changed

📖 Documentation Quality Standards

All documentation follows these principles:

  • Clear examples - Actual JSON and code, not just theory
  • Task-oriented - Organized by what you want to do
  • Cross-referenced - Links to related docs
  • Current - Updated when code changes
  • Searchable - Use descriptive headings

See DOCUMENTATION_GUIDE.md for maintenance details.

❓ Can't Find Something?

Use DOCUMENTATION_MAP.md to:

  • Find docs by audience (user vs developer)
  • Find docs by task ("I want to...")
  • See document relationships
  • Navigate the documentation structure

💡 Tips

  • Bookmark DOCUMENTATION_MAP.md - It's your navigation hub
  • Use the search functionality - Look for keywords
  • Follow links - Documents cross-reference each other
  • Check examples/ - Real-world automations show patterns in use
  • Update docs when coding - Keep changes in sync with documentation

📝 Contributing to Documentation

Before making changes to any documentation:

  1. Read DOCUMENTATION_GUIDE.md
  2. Check the update checklist
  3. Run pnpm format before committing

Last Updated: December 2025
Maintainer: Loopi Documentation Team