Documentation Upload

Status: Coming Soon

Documentation upload features are coming to the Admin UI. This guide covers the features you can expect when they launch.

Overview

The Documentation Upload feature allows you to build a comprehensive knowledge base for your ChatSDK integration. This documentation powers intelligent, context-aware responses through semantic search and retrieval-augmented generation (RAG).

Coming Soon: Key Features

Upload Documentation

(Coming Soon) Upload various document formats:

• Markdown (.md) - Recommended format
• PDF (.pdf) - Automatically extracted and processed
• HTML (.html) - Parsed and converted
• Text (.txt) - Plain text files

Supported Formats

Markdown

Best format for ChatSDK:

# Product Guide

## Getting Started

Start by installing the package...

## API Reference

### `useChat()` Hook

...

Benefits:

• Preserves structure (headers, lists, code blocks)
• Easy to version control
• Works with documentation generators

PDF

Perfect for existing documentation:

Product_Guide.pdf (automatic extraction)
API_Reference.pdf
User_Manual.pdf

Processing:

• Automatically extracts text
• Preserves formatting information
• Handles images and diagrams (metadata)

HTML

For web-based documentation:

<div class="documentation">
  <h1>Product Guide</h1>
  <p>Start by installing...</p>
</div>

Processing:

• Extracts text content
• Preserves semantic structure
• Removes navigation/boilerplate

Bulk Upload

(Coming Soon) Upload multiple documents at once:

1. Go to Documentation section
2. Click Bulk Upload
3. Select multiple files
4. Click Upload
5. Monitor processing progress

Organize & Categorize

(Coming Soon) Organize documentation:

• Categories: User Guide, API Reference, Troubleshooting
• Tags: Features, Authentication, Database
• Importance: Critical, High, Medium, Low
• Page Mapping: Link docs to specific pages

Processing & Indexing

(Coming Soon) Automatic processing:

1. Extract: Parse content from any format
2. Clean: Remove boilerplate and noise
3. Chunk: Split into semantic chunks
4. Embed: Generate vector embeddings
5. Index: Store in vector database
6. Ready: Available for retrieval

Processing Status:

• Queued - Waiting to process
• Processing - Currently being processed
• Indexed - Ready for use
• Error - Failed, check details

Quality Metrics

(Coming Soon) Understand your knowledge base:

• Total Documents: Number of uploaded files
• Total Chunks: Number of indexed pieces
• Coverage: % of code features documented
• Quality Score: Relevance and completeness
• Last Updated: When indexing completed

Version History

(Coming Soon) Track documentation versions:

• Upload new versions
• Rollback to previous versions
• See what changed
• Compare versions

Knowledge Base Analytics

(Coming Soon) Monitor retrieval performance:

• Most Retrieved: Most commonly used docs
• Relevance Score: How well docs match queries
• Coverage Gaps: What's missing
• Suggestions: What to document next

Getting Your Documentation Ready

Prepare Your Docs

1. Gather all documentation files
2. Organize by category (API, Guides, Troubleshooting)
3. Clean up old or outdated content
4. Review for accuracy and completeness
5. Format consistently

Recommended Structure

documentation/
├── getting-started/
│   ├── installation.md
│   ├── quick-start.md
│   └── first-project.md
├── api-reference/
│   ├── authentication.md
│   ├── endpoints.md
│   └── errors.md
├── guides/
│   ├── authentication.md
│   ├── customization.md
│   └── advanced-usage.md
└── troubleshooting/
    ├── common-errors.md
    ├── faq.md
    └── getting-help.md

Documentation Best Practices

1. Use Clear Headings

# Main Topic
## Subtopic
### Specific Item

(Not: # #### Paragraph text)

2. Include Code Examples

## Example Usage

```javascript
const result = await sdk.doSomething();

Code examples help retrieval and understanding.

#### 3. Link Related Content

```markdown
See also:
- [Authentication Guide](./authentication.md)
- [API Reference](./api-reference.md)

4. Add Context

## Setting Up Authentication

Before you can make API calls, you need to:
1. Create an account
2. Generate an API key
3. Configure the SDK with your key

5. Document Edge Cases

## Known Limitations

- Maximum file size: 100MB
- Rate limit: 1000 requests/minute
- Currently supports: English only

Converting Existing Docs

From HTML

Use Pandoc to convert:

pandoc index.html -t markdown -o documentation.md

From PDF

Use tools to extract text, then clean up:

• PDF2Markdown
• Unstructured.io
• Manual conversion for important docs

From Confluence/Notion

1. Export as HTML or Markdown
2. Clean up formatting
3. Upload to ChatSDK

When to Upload Documentation

Essential Documentation

Required for good chat responses:

• Product overview
• Core features
• API reference
• Common workflows
• Authentication/setup

Recommended Documentation

Improves response quality:

• Detailed guides
• Code examples
• Troubleshooting tips
• FAQ section
• Edge cases

Optional Documentation

Nice to have:

• Marketing materials
• Blog posts
• Video transcripts
• Community contributions
• Old versions

Using Documentation in Chat

Once uploaded, your documentation is automatically used:

User: "How do I authenticate?"
  ↓ (System retrieves relevant docs)
  ↓ (Combines with page context)
  ↓ (Sends to Claude AI)
Assistant: "Based on your docs, here's how to authenticate..."

What Makes a Good Response

1. Accurate - Based on your actual documentation
2. Relevant - Matches the user's question
3. Contextual - Considers what page they're on
4. Complete - Provides enough detail
5. Helpful - Actionable and clear

Improving Documentation Quality

Monitor Performance

1. Go to Documentation → Analytics
2. Check which docs are retrieved most
3. Check relevance scores
4. Read suggestions for gaps

Fill Knowledge Gaps

If certain topics aren't documented:

1. Note the gaps in analytics
2. Write documentation for missing features
3. Upload updated docs
4. Monitor retrieval rates

Update Outdated Content

1. Keep track of code changes
2. Update docs when features change
3. Upload new versions
4. Monitor accuracy

Transition Path

When Documentation Upload launches:

1. You can upload your existing documentation
2. It's automatically processed and indexed
3. Chat responses immediately use the docs
4. No migration needed

Related Documentation

• Admin UI Overview - Overview of dashboard features
• Doc Generation CLI - Auto-generate documentation from code
• Getting Started Guide - Quick setup guide
• Guides - Context-Aware Chat - How context works