osw-studio / docs /README.md
otst's picture
migrate server mode to sqlite and fix memory leaks
115d3f3

OSW Studio Documentation

Your guide to building websites with AI.

Welcome to OSW Studio - a browser-based development environment where you chat with AI to build complete websites.


Quick Links

New to OSW Studio?

Common Tasks:

Features:

  • πŸ“¦ Templates - Start faster
  • ⚑ Skills - Teach AI your preferences

Need Help?


Documentation Structure

Getting Started

Perfect for newcomers and casual users:

Using OSW Studio

Guides for regular users:

Help & Advanced

For support and self-hosters:


What Can I Build?

OSW Studio is perfect for creating static websites:

βœ… Personal websites - Portfolios, blogs, resumes βœ… Landing pages - Marketing sites, product pages βœ… Documentation sites - Project docs, help centers βœ… Interactive apps - Calculators, tools, games (client-side)

❌ Not for backend - No server-side code, databases, or APIs (unless self-hosting)


Key Concepts

Chat with AI to Build

Describe what you want in plain English. AI writes the code, creates files, and explains what it's doing.

Create a portfolio website with a hero section,
about section, and project gallery

Two Modes

πŸ’¬ Chat Mode - Ask questions, plan, explore (read-only) πŸ”§ Code Mode - AI builds and modifies your project

Live Preview

See your website update in real-time as AI builds it.

Export & Deploy

Download your complete site and deploy to Vercel, Netlify, or any static host in minutes.


Resources

External Links

Features

Major Features:

  • Multi-provider AI support (8 providers)
  • Dual modes (Chat/Code)
  • Templates & Skills systems
  • Browser mode (IndexedDB)
  • Optional Server mode
  • Static site publishing
  • Cost tracking

Getting Help

Before asking for help:

  1. Check the FAQ
  2. Search GitHub Issues
  3. Review Troubleshooting

Still stuck?

Create an issue on GitHub with:

  • What you're trying to do
  • What's happening instead
  • Steps to reproduce
  • Browser and OS version
  • Screenshots if relevant

Ready to start? β†’ Get Started