Getting Started
Learn the basics of Offworld
Welcome to Offworld! This section will help you understand what Offworld is and how to start using it.
Start Here
Introduction
What is Offworld and why should you use it?
Quick Start
Explore a repository in 3 steps
Key Concepts
RAG, architecture discovery, and AI agents
Use Cases
When and how to use Offworld
What is Offworld?
Offworld is an AI-powered repository analysis system that helps developers understand unfamiliar codebases quickly through:
- AI-generated summaries - 300-word overviews
- Architecture discovery - Automatic component identification
- Issue analysis - Difficulty ratings and skill requirements
- RAG-powered chat - Interactive Q&A about any repository
Try It Now
Explore our own repository as an example:
offworld.sh/oscabriel/offworld
Learning Path
New to Offworld? Follow this path:
- Introduction - Understand the problem and solution
- Quick Start - Analyze your first repository (5 minutes)
- Key Concepts - Learn how RAG and progressive discovery work
- Use Cases - Discover real-world applications
Next Steps
After completing Getting Started:
- Start using Offworld → User Guide
- Want to contribute? → Developer Guide
- Need API details? → Technical Reference