Skip to content

START_HERE.md

Latest commit

 

History

History
96 lines (65 loc) · 2.44 KB

START_HERE.md

File metadata and controls

96 lines (65 loc) · 2.44 KB
Raw

🚀 START HERE - First Time Users

What Is This?

A professional Monaco Editor configuration tool + Couchbase Search Workbench in one application.

Think Storybook for Monaco Editor plus an intelligent JSON query editor.

Quick Start

npm install
npm run dev
# Open http://localhost:5173

Two Main Features

1. Monaco Editor Playground 🎨

What: Configure Monaco Editor with 55+ options
Why: Find your perfect editor setup
How: Click tabs, adjust options, copy configuration

Try This (30 seconds):

  1. Click Basic tab → Change language to Python
  2. Click Display tab → Set cursor to "Block"
  3. Click Copy Config → Get JSON configuration

2. Search Workbench 🔍

What: Build Couchbase FTS (Full-Text Search) queries
Why: Easier than writing JSON manually
How: Type queries with autocomplete + hover docs

Try This (30 seconds):

  1. Go to Search Workbench section
  2. Type { then "
  3. See autocomplete suggestions
  4. Hover over any keyword for documentation

Documentation Quick Links

For... Read... Time
Demo stakeholders DEMO_GUIDE.md 5 min
Getting started QUICKSTART.md 2 min
Feature details STORYBOOK_GUIDE.md 15 min
Developers README.md 10 min

Most Important Features

✅ 55 Configuration Options - Most comprehensive Monaco playground
✅ 6 Organized Sections - No overwhelming lists
✅ Live Preview - See changes instantly
✅ Hover Documentation - 69 markdown help files
✅ Autocomplete - Intelligent keyword suggestions
✅ Validation - Real-time error checking

Common First Questions

Q: Where's the run button?
A: Inside the editor at top-right (enable it in Basic tab)

Q: How do I save my configuration?
A: Click "Copy Config" button to export as JSON

Q: Is this for Monaco Editor or Search Workbench?
A: Both! Two features in one app.

Q: Can I use this in production?
A: Monaco Playground: Yes. Search Workbench: ~30% complete (in development).

Next Steps

  1. Explore - Click around, try features
  2. Demo - Follow DEMO_GUIDE.md if presenting
  3. Learn - Read STORYBOOK_GUIDE.md for all options
  4. Develop - See README.md for integration details

Welcome aboard! 🎉
You now have the most powerful Monaco Editor playground ever built.