Knowledge Base

The Knowledge Base is your workspace's central repository for documentation, standard operating procedures, playbooks, and team knowledge. With AI-powered semantic search, finding information is fast and intuitive.

Screenshot needed � add an annotated image showing this UI

What Is the Knowledge Base?

Think of the Knowledge Base as your team's internal wiki:

• Document everything — SOPs, meeting notes, project docs, and more
• Find instantly — AI-powered search understands meaning, not just keywords
• Stay organized — Use scopes and tags to categorize content
• Import existing docs — Sync from GitHub or import markdown files

Creating Documents

Quick Create

1. Navigate to Knowledge Base in the sidebar
2. Click New Document
3. Enter a title
4. Select a scope (see below)
5. Click Create

You'll be taken to the document editor to start writing.

Document Scopes

Every document has a scope that determines visibility:

The Document Editor

Workestra uses a rich text editor (Tiptap) with support for:

Screenshot needed � add an annotated image showing this UI

AI-Powered Search

The Knowledge Base features hybrid semantic search that combines three search techniques for the best results.

How It Works

Results are combined using Reciprocal Rank Fusion to surface the most relevant documents.

Using Search

1. Type in the search bar (top of Knowledge Base page)
2. When you enter 3+ characters, AI search activates automatically
3. Results update in real-time as you type
4. An "AI Search" indicator appears when semantic search is active

Search by Scope

Use the scope tabs to filter documents:

• All — Search across all scopes
• Workspace — Only workspace-level documents
• Teams — Team-scoped documents you have access to
• Projects — Project documents for your projects

Organizing with Tags

Tags help categorize and filter documents:

Viewing Tags

Available tags appear below the scope tabs. Click a tag to filter documents.

Common Tag Patterns

Import from GitHub

Already have documentation in GitHub? Import it directly into the Knowledge Base.

Prerequisites

• A GitHub account with access to your repositories
• Repositories containing markdown (.md) files

Connecting GitHub

1. Go to Knowledge Base
2. Click the ... (more options) menu
3. Select Import from GitHub
4. Complete the OAuth flow with GitHub
5. Grant repository access permissions

Selecting Repositories and Files

After connecting:

1. Select the repository to import from
2. Choose the branch (usually main or master)
3. Select specific folders or files
4. Choose import options:
   • Import as workspace docs — Available to everyone
   • Import as personal docs — Private to you

How Sync Works

Documents are imported via the sync-github-docs edge function:

• Markdown files are converted to Knowledge Base documents
• Frontmatter (YAML headers) is preserved as metadata
• File structure becomes document tags

Troubleshooting GitHub Import

Generate with AI

Document Best Practices

Writing Effective Docs

1. Start with a clear title — Use descriptive, searchable titles
2. Add a table of contents — For longer documents, include TOC
3. Use headings liberally — Makes scanning and linking easier
4. Tag appropriately — Helps with discovery and filtering
5. Choose the right scope — Don't over-share sensitive docs

Document Lifecycle

Keyboard Shortcuts

---

Next Steps

• GitHub Sync — Detailed guide to GitHub integration
• AI Assistant — Use AI to search and create content