Skip to content

docs: update technical FAQ, support FAQ, and AI server run instructions #3847

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
+17 −1
Closed

docs: update technical FAQ, support FAQ, and AI server run instructions #3847

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
8 changes: 8 additions & 0 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 @@ -34,6 +34,14 @@ pnpm -F web dev
pnpm -F api dev
```

## 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.

# Supabase

- https://supabase.com/docs/guides/local-development/cli/getting-started
Expand Down
8 changes: 8 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 @@ -15,3 +15,11 @@ The app itself is about 200MB. Recording storage depends on your usage - a 1-hou
## Does Hyprnote work offline?

Yes! Since Hyprnote uses local AI, it works completely offline. You don't need an internet connection to record, transcribe, or generate summaries.

## How does Hyprnote route cloud LLM requests?

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.

## 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.
2 changes: 1 addition & 1 deletion apps/web/content/docs/faq/5.support.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: "Questions about getting help and support for Hyprnote."

## How do I get help if something isn't working?

The fastest way to get help is through the **in-app support chat**. Click your profile icon in the sidebar and select **Report Bug** or **Suggest Feature** to open a support conversation. The chat automatically collects your device information and can submit bug reports or feature requests directly.
The fastest way to get help is through the **in-app support chat**. Click your profile icon in the sidebar and select **Report Bug** or **Suggest Feature** to open a support conversation. The chat automatically collects your device information and can submit bug reports or feature requests directly. It can also search existing GitHub issues and discussions to check whether your problem has already been reported or addressed.

You can also reach us through our Discord community or by opening an issue on [GitHub](https://github.com/fastrepl/hyprnote/issues).

Expand Down
Loading