Search Documentation
Umwelten's documentation includes a powerful search functionality that helps you quickly find the information you need.
Quick Search
Keyboard Shortcuts
- Cmd+K (macOS) or Ctrl+K (Windows/Linux): Open search modal
- Escape: Close search modal
- Arrow keys: Navigate through search results
- Enter: Select highlighted result
Search Features
The search functionality includes:
- Full-text search: Search through all content, headings, and code
- Fuzzy matching: Find results even with typos or partial matches
- Relevance scoring: Most relevant results appear first
- Keyword highlighting: Search terms are highlighted in results
- Real-time results: See results as you type
What's Searchable
The search indexes:
- Page titles: Exact and partial matches
- Content: All text content on pages
- Headings: Section and subsection titles
- Code blocks: Code examples and snippets
- Frontmatter keywords: Custom keywords added to pages
- File paths: Page URLs and navigation structure
Search Tips
Use Specific Terms
Instead of searching for "model", try:
- "Google models"
- "model evaluation"
- "BaseModelRunner"
Use Technical Terms
Search for specific technical concepts:
- "Zod schemas"
- "structured output"
- "MCP integration"
- "semantic architecture"
Search by Provider
Find provider-specific information:
- "OpenRouter"
- "Ollama"
- "Google Gemini"
- "LM Studio"
Search by Feature
Find feature-specific documentation:
- "memory system"
- "tool calling"
- "batch processing"
- "cost analysis"
Search Result Categories
Search results are organized by:
- Exact title matches (highest priority)
- Heading matches (high priority)
- Content matches (medium priority)
- Keyword matches (medium priority)
- Fuzzy matches (lower priority)
Advanced Search
Search Operators
While the search doesn't support complex operators, you can:
- Use quotes: Search for exact phrases
- Combine terms: Use multiple words for more specific results
- Use technical terms: Leverage specific terminology for better results
Search Examples
| What you're looking for | Try searching for |
|---|---|
| Installation instructions | "getting started" |
| API documentation | "TypeScript API" |
| Model evaluation | "eval run" |
| Provider setup | "OpenRouter setup" |
| Error troubleshooting | "troubleshooting" |
| Code examples | "examples" |
Search Analytics
The search system tracks usage to improve relevance and help identify popular search terms. This helps us:
- Improve search result relevance
- Identify documentation gaps
- Understand user needs
- Optimize content organization
Troubleshooting Search
No Results Found
If you're not finding what you're looking for:
- Try different terms: Use synonyms or related terms
- Check spelling: Ensure search terms are spelled correctly
- Use broader terms: Start with general terms, then refine
- Check the navigation: Use the sidebar navigation as an alternative
Search Not Working
If the search functionality isn't working:
- Refresh the page: Try reloading the documentation
- Check your browser: Ensure JavaScript is enabled
- Clear cache: Clear your browser cache and try again
- Try a different browser: Test in an alternative browser
Feedback
If you have suggestions for improving the search functionality:
- Open an issue on GitHub
- Include specific examples of searches that didn't work as expected
- Describe what you were looking for and what you found instead
Related Topics
- Getting Started: Learn the basics of Umwelten
- Model Discovery: Find and explore available models
- API Reference: Comprehensive API documentation
- Examples: Practical examples and use cases