Onboarding

Onboarding Flows

Flow 1: Workspace Discovery

Help users understand their workspace:

// 1. Show workspace info
const workspace = await get_workspace();
const projects = await projects_list();

// 2. Present overview

## Your Workspace: {workspace.name}

You have access to **{projects.length}** projects:

{projects.map(p => `
### ${p.name}
- ${p.documentCount} documents
- Last updated: ${p.lastUpdated}
`).join('\n')}

**Where to start:**
- 🌟 Most active project: {mostActive.name}
- 📈 Recently updated: {recentlyUpdated.name}
- 📚 Largest documentation: {largest.name}

Which project would you like to explore?

Flow 2: Document Structure Tour

Show how docs are organized:

// 1. Pick a representative project
const project = await suggestGoodStartingProject();

// 2. Get its structure
const tree = await docs_tree({ projectId: project.id });

// 3. Explain the structure

## How Your Documentation is Organized

Here's the structure of **{project.name}**:

📁 {project.name} ├─ 📄 Getting Started │ ├─ 📄 Installation │ └─ 📄 Quick Start ├─ 📄 User Guide │ ├─ 📄 Basic Features │ └─ 📄 Advanced Features └─ 📄 API Reference ├─ 📄 Authentication └─ 📄 Endpoints

**Understanding the structure:**
- 📁 **Projects** organize related documentation
- 📄 **Documents** can have parent-child relationships
- 🔗 **Links** connect related topics across documents (use `[[alias]]` format)

**Try it yourself:**
- "Show me the Getting Started guide"
- "What's in the User Guide?"
- "Find all API documentation"

Flow 3: First Search Experience

Teach search capabilities:

## Let's Try Searching! 🔍

Meldoc can search through all your documentation instantly.

**What to search for:**
- Specific features: "authentication", "deployment"
- Error messages: "connection timeout", "404 error"
- Concepts: "best practices", "architecture"
- Code examples: "python example", "API call"

**Try asking:**
- "Find documentation about authentication"
- "Search for deployment guides"
- "Show me code examples"

**What would you like to search for?**

After first search:

## Great! Here's what I found:

{search_results}

**Search tips:**
✅ Use specific technical terms
✅ Include 2-3 keywords for best results
✅ Try variations if you don't find what you need
❌ Avoid very broad single words

**Next steps:**
- Click any document to read it
- Ask me to "explain {topic}" for a summary
- Search for related topics

Flow 4: First Document Creation

Guide through creating a doc:

## Let's Create Your First Document! ✏️

I'll help you create a well-structured document with proper Meldoc format.

**First, let me ask a few questions:**

1. **What's the topic?**
   (e.g., "API Authentication Guide", "Deployment Process")

2. **Who is it for?**
   - [ ] Developers
   - [ ] End users
   - [ ] Administrators
   - [ ] General audience

3. **What type of document?**
   - [ ] Tutorial (step-by-step)
   - [ ] Reference (technical details)
   - [ ] Guide (conceptual explanation)
   - [ ] How-to (specific task)

Based on your answers, I'll create a structured outline with proper frontmatter!

After getting answers:

## Perfect! Here's what I'll create:

**Title:** {title}
**Type:** {type}
**Audience:** {audience}

**Suggested structure:**

```markdown
---