Skip to content

docs: fix apps/ai references after consolidation, add Tantivy search docs #3889

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
devin-ai-integration wants to merge 1 commit into from
Closed

docs: fix apps/ai references after consolidation, add Tantivy search docs #3889

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions apps/web/content/docs/developers/1.env.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@ S3_SECRET_KEY="850181e4652dd023b7a98c58ae0d2d34bd487ee0cc3254aed6eda37307425907"
S3_REGION="local"
```

See `apps/web/package.json`, `apps/api/package.json`, and `apps/restate/package.json` to see how `.env.supabase` is used.
See `apps/web/package.json` and `apps/restate/package.json` to see how `.env.supabase` is used.

# AI Server (apps/ai)
# API Server (apps/api)

The AI server uses the `envy` crate for structured environment configuration. It loads `.env.supabase` from the repo root and `.env` from `apps/ai/`. Create a `.env` file in `apps/ai/` with:
The API server uses the `envy` crate for structured environment configuration. It loads `.env.supabase` from the repo root and `.env` from `apps/api/`. Create a `.env` file in `apps/api/` with:

```bash
PORT=3001 # default: 3001
Expand Down
10 changes: 2 additions & 8 deletions apps/web/content/docs/developers/5.run.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,10 @@ pnpm -F web dev
## API (apps/api)

```bash
pnpm -F api dev
cargo run -p api
```

## AI Server (apps/ai)

```bash
cargo run -p ai
```

The AI server handles LLM proxying (via OpenRouter), STT proxying, calendar integration, subscriptions, and the in-app support chat MCP server. See [Environment Variables](/docs/developers/env) for required configuration.
The API server handles LLM proxying (via OpenRouter), STT proxying, calendar integration, subscriptions, and the in-app support chat MCP server. See [Environment Variables](/docs/developers/env) for required configuration.

# Supabase

Expand Down
2 changes: 1 addition & 1 deletion apps/web/content/docs/faq/1.features.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Yes! Hyprnote supports backlink mentions. Type `@` in a note to search for and l

## Can I search across all my notes?

Yes. Press <kbd>⌘</kbd> + <kbd>⇧</kbd> + <kbd>F</kbd> to open the Advanced Search tab, which lets you search across all sessions with filters by type (meeting notes, people, organizations) and date range (today, this week, this month). Results highlight matching text in context.
Yes. Press <kbd>⌘</kbd> + <kbd>⇧</kbd> + <kbd>F</kbd> to open the Advanced Search tab, which uses Tantivy-powered full-text search to find matches across all sessions. You can filter by type (meeting notes, people, organizations) and date range (today, this week, this month). Results highlight matching text in context.

## What views does the calendar support?

Expand Down
4 changes: 4 additions & 0 deletions apps/web/content/docs/faq/3.technical.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ Yes! Since Hyprnote uses local AI, it works completely offline. You don't need a

When using cloud AI (Hyprnote Pro), LLM requests are routed through [OpenRouter](https://openrouter.ai). OpenRouter acts as a unified gateway to multiple model providers (OpenAI, Anthropic, Google, and others), so Hyprnote can switch between models without requiring separate API keys for each provider. A single `OPENROUTER_API_KEY` is all that's needed for cloud LLM access.

## How does in-app search work?

Hyprnote uses [Tantivy](https://github.com/quickwit-oss/tantivy), a Rust full-text search engine, to index and search your notes locally. Documents are indexed in the background as you create and edit sessions. The search supports filtering by type (meeting notes, people, organizations) and date range, with results ranked by relevance.

## What is the support chat powered by?

The in-app support chat uses the [Model Context Protocol (MCP)](https://modelcontextprotocol.io) to connect to Hyprnote's support server. The MCP server provides tools that can submit bug reports as GitHub issues, create feature requests as GitHub discussions, and query existing GitHub data (issues, pull requests, comments, tags) to help answer questions about known problems or planned features.
Loading