Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ S3_REGION="local"

See `apps/web/package.json`, `apps/api/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 (formerly `apps/ai`) 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 Expand Up @@ -75,7 +75,7 @@ GITHUB_DISCUSSION_CATEGORY_ID="" # required for support chat
SUPPORT_DATABASE_URL="" # required for support chat
```

At least one STT provider API key is required for transcription to work. The Nango and Stripe variables are required for calendar and subscription APIs. The GitHub and support database variables are required for the in-app support chat MCP server, which handles bug reports and feature requests.
At least one STT provider API key is required for transcription to work. The Nango and Stripe variables are required for calendar and subscription APIs. The GitHub and support database variables are required for the in-app support chat MCP server, which handles GitHub issue management and billing operations.

# Stripe Webhook Service (apps/stripe)

Expand Down
12 changes: 3 additions & 9 deletions apps/web/content/docs/developers/5.run.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,13 @@ pnpm -F ui build && pnpm -F desktop tauri dev
pnpm -F web dev
```

## API (apps/api)
## API Server (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 (formerly `apps/ai`) 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
12 changes: 12 additions & 0 deletions apps/web/content/docs/faq/1.features.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,18 @@ Yes. On macOS, right-click the Hyprnote icon in the Dock to see a context menu w

Yes. The AI chat bubble can be expanded into a full tab for a more spacious conversation view. You can also open a support chat tab from the profile menu in the sidebar by selecting **Report Bug** or **Suggest Feature**.

## Can I select and delete multiple notes at once?

Yes. In the sidebar timeline, you can select multiple sessions using <kbd>⌘</kbd> + click or <kbd>⇧</kbd> + click, then right-click to bulk delete them. A confirmation toast appears with an undo option.

## Does Hyprnote auto-generate summaries?

Yes. When you stop a recording, Hyprnote can automatically trigger AI-powered note enhancement to generate a summary from the transcript. This also works after uploading or retranscribing a recording.

## Can I see calendar event details in a note?

Yes. When a session is linked to a calendar event, the event description appears as a metadata chip in the session header. Click it to view the full event details.

## Can I undo deleting a note?

Yes! When you delete a note, a toast notification appears giving you a few seconds to undo the deletion. You can also press <kbd>⌘</kbd> + <kbd>Z</kbd> to restore the most recently deleted note before the undo window expires.
2 changes: 1 addition & 1 deletion apps/web/content/docs/faq/3.technical.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ When using cloud AI (Hyprnote Pro), LLM requests are routed through [OpenRouter]

## 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.
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 for GitHub issue management (`search_issues`, `create_issue`, `add_comment`) and Stripe billing operations (`list_subscriptions`, `create_billing_portal_session`). It also serves MCP prompts that guide the chat's behavior. Destructive actions like creating issues require user confirmation before executing.
2 changes: 1 addition & 1 deletion apps/web/content/docs/faq/5.support.mdx
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. It can also search existing GitHub issues and discussions to check whether your problem has already been reported or addressed.
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 can search existing GitHub issues, create new issues, or add comments to existing ones. It also supports billing inquiries — you can check your subscription status or open the billing portal directly from the chat. Destructive actions (like creating an issue) require your confirmation before executing.

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

Expand Down
8 changes: 4 additions & 4 deletions apps/web/content/docs/faq/6.keyboard-shortcuts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ description: "Complete list of keyboard shortcuts in Hyprnote."

## Application

| Shortcut | Action |
| ------------------------------------- | ---------------------------------------------- |
| <kbd>⌘</kbd> + <kbd>Q</kbd> (hold) | Quit Hyprnote (hold for 1.5 seconds to confirm) |
| <kbd>⌘</kbd> + <kbd>Q</kbd> (tap) | Show quit overlay |
| Shortcut | Action |
| ------------------------------------------------- | ---------------------------------------------- |
| <kbd>⌘</kbd> + <kbd>Q</kbd> (hold) | Show quit overlay with gauge visual |
| <kbd>⌘</kbd> + <kbd>⇧</kbd> + <kbd>Q</kbd> | Quit Completely |
Loading