Skip to content

Commit 594f5fd

Browse files
docs: add cross-links between related documentation pages (#3854)
1 parent 7088d6c commit 594f5fd

File tree

12 files changed

+38
-13
lines changed

12 files changed

+38
-13
lines changed

apps/web/content/docs/about/2.why-local-first.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,9 @@ Local tools don't care about your connection. Record and transcribe meetings on
2525
## Best of Both Worlds
2626

2727
Want collaboration? Use self-hosted sync or cloud features when you need them, while keeping local-first benefits.
28+
29+
## Learn More
30+
31+
- [AI Models & Data Privacy](/docs/faq/ai-models-and-privacy) - how your data is handled with different AI providers
32+
- [Local LLM Setup](/docs/faq/local-llm-setup) - run AI models entirely on your device
33+
- [Local Models](/docs/developers/local-models) - local speech-to-text model details

apps/web/content/docs/developers/16.local-models.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ description: "Learn about local models in Hyprnote"
99
- https://lmstudio.ai
1010
- https://lemonade-server.ai
1111

12+
For step-by-step setup instructions for LM Studio and Ollama, see the [Local LLM Setup guide](/docs/faq/local-llm-setup).
13+
1214
## Speech-to-Text (STT)
1315

1416
- All STT models are stored in `~/Library/Application Support/hyprnote/models/stt/`
@@ -23,6 +25,8 @@ description: "Learn about local models in Hyprnote"
2325
| https://huggingface.co/argmaxinc/parakeetkit-pro/tree/main/nvidia_parakeet-v3_494MB | `nvidia_parakeet-v3_494MB` |
2426
| https://huggingface.co/argmaxinc/ctckit-pro/tree/main/parakeet-tdt_ctc-110m | `parakeet-tdt_ctc-110m` |
2527

28+
For details on how your data is handled when using local vs cloud models, see [AI Models & Data Privacy](/docs/faq/ai-models-and-privacy).
29+
2630
If you have [Huggingface CLI](https://huggingface.co/docs/huggingface_hub/guides/cli) installed:
2731

2832
```bash

apps/web/content/docs/faq/0.general.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ Hyprnote is a desktop notetaking application that captures both your microphone
1010

1111
## How is Hyprnote different from other meeting recorders?
1212

13-
Unlike bot-based recorders that join your meetings, Hyprnote runs locally on your computer and captures audio directly from your system. This means it works with any application, doesn't require meeting permissions, and keeps all your data private.
13+
Unlike bot-based recorders that join your meetings, Hyprnote runs locally on your computer and captures audio directly from your system. This means it works with any application, doesn't require meeting permissions, and keeps all your data private. Learn more in [What is Hyprnote?](/docs/about/what-is-hyprnote) and [Why Local-First?](/docs/about/why-local-first).

apps/web/content/docs/faq/1.features.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Hyprnote supports transcription and AI features in 45+ languages including:
2828

2929
- Arabic, Indonesian, Malay, Vietnamese, Thai, Tagalog, Tamil, Hindi, Hebrew, Azerbaijani, Catalan, Galician, Macedonian, Bosnian, Estonian, Slovenian, Latvian, Lithuanian
3030

31-
You can select your main language and add additional spoken languages in the app's settings under "Language & Vocabulary". The main language is used for summaries, chats, and AI-generated responses, while spoken languages help improve transcription accuracy when multiple languages are used in a meeting.
31+
You can select your main language and add additional spoken languages in the app's settings under "Language & Vocabulary". The main language is used for summaries, chats, and AI-generated responses, while spoken languages help improve transcription accuracy when multiple languages are used in a meeting. See [Better Transcription](/docs/pro/better-transcription) for provider language support details.
3232

3333
## Do my pinned tabs persist across restarts?
3434

@@ -48,7 +48,7 @@ Yes. Press <kbd>⌘</kbd> + <kbd>⇧</kbd> + <kbd>F</kbd> to open the Advanced S
4848

4949
## What views does the calendar support?
5050

51-
The calendar tab (<kbd>⌘</kbd> + <kbd>⇧</kbd> + <kbd>C</kbd>) supports week, 3-day, and day views. You can switch between them using the controls at the top of the calendar. Events display inline with time slots, and clicking an event opens a popover where you can create a session from it.
51+
The calendar tab (<kbd>⌘</kbd> + <kbd>⇧</kbd> + <kbd>C</kbd>) supports week, 3-day, and day views. You can switch between them using the controls at the top of the calendar. Events display inline with time slots, and clicking an event opens a popover where you can create a session from it. See [Calendar](/docs/calendar/apple) for setup instructions.
5252

5353
## Can I unignore a calendar event?
5454

apps/web/content/docs/faq/10.ai-models-and-privacy.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Hyprnote uses two types of AI models: speech-to-text (STT) models for transcript
1010

1111
### Speech-to-Text Models
1212

13-
Hyprnote supports multiple cloud-based STT providers for transcription. See the cloud providers section below for details.
13+
Hyprnote supports multiple cloud-based STT providers for transcription. See the cloud providers section below for details. For local STT models and manual download instructions, see [Local Models](/docs/developers/local-models#speech-to-text-stt).
1414

1515
### Large Language Models
1616

@@ -28,7 +28,7 @@ Hyprnote offers multiple options for AI features like summaries and note generat
2828

2929
**Qwen** - Alibaba's open-source language model with strong multilingual capabilities.
3030

31-
See our [Local LLM Setup guide](/docs/faq/local-llm-setup) for instructions on configuring LM Studio or Ollama with Hyprnote.
31+
See our [Local LLM Setup guide](/docs/faq/local-llm-setup) for instructions on configuring LM Studio or Ollama with Hyprnote. Pro users can also access curated cloud transcription and AI models - see [Better Transcription](/docs/pro/better-transcription) and [Cloud Services](/docs/pro/cloud).
3232

3333
## Does my audio data leave my device?
3434

@@ -77,4 +77,4 @@ For maximum privacy:
7777
3. Review the privacy policies of your chosen STT provider
7878
4. Review your settings in Settings > Intelligence
7979

80-
When using local LLM servers, your notes and summaries are generated on your device without being sent to external servers.
80+
When using local LLM servers, your notes and summaries are generated on your device without being sent to external servers. Learn more about our local-first philosophy in [Why Local-First?](/docs/about/why-local-first)

apps/web/content/docs/faq/2.privacy.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,5 @@ Yes, all your data is encrypted at rest on your device. Your recordings, transcr
1515
## Can my employer see my Hyprnote recordings?
1616

1717
No. Hyprnote stores everything locally on your device. Unless you explicitly share your notes or recordings, they remain private to you.
18+
19+
For more details on how AI models handle your data, see [AI Models & Data Privacy](/docs/faq/ai-models-and-privacy). To learn more about our local-first approach, see [Why Local-First?](/docs/about/why-local-first).

apps/web/content/docs/faq/3.technical.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ The app itself is about 200MB. Recording storage depends on your usage - a 1-hou
1414

1515
## Does Hyprnote work offline?
1616

17-
Yes! Since Hyprnote uses local AI, it works completely offline. You don't need an internet connection to record, transcribe, or generate summaries.
17+
Yes! Since Hyprnote uses local AI, it works completely offline. You don't need an internet connection to record, transcribe, or generate summaries. See [Local Models](/docs/developers/local-models) for available local STT models and [Local LLM Setup](/docs/faq/local-llm-setup) for configuring local AI.

apps/web/content/docs/faq/8.settings.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@ description: "How to transcribe files in Hyprnote."
66

77
# File Transcription
88

9-
- If using Cloud provider, any file supported by the provider can be transcribed.
10-
- If using Local provider, anything that can be decoded by `rodio` with `symphonia-all` enabled can be transcribed.
9+
- If using Cloud provider, any file supported by the provider can be transcribed. See [Better Transcription](/docs/pro/better-transcription) for available cloud providers.
10+
- If using Local provider, anything that can be decoded by `rodio` with `symphonia-all` enabled can be transcribed. See [Local Models](/docs/developers/local-models) for local STT model details.

apps/web/content/docs/faq/9.local-llm-setup.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ section: "FAQ"
44
description: "How to set up LM Studio or Ollama for local AI in Hyprnote."
55
---
66

7+
This guide covers setting up local LLMs for AI features like summaries and notes. If you're looking for local speech-to-text models, see [Local Models](/docs/developers/local-models#speech-to-text-stt).
8+
79
## LM Studio Setup
810

911
[LM Studio](https://lmstudio.ai) is a desktop application that lets you run large language models locally on your computer.
@@ -69,3 +71,7 @@ If Hyprnote cannot connect to Ollama:
6971
- On macOS, Ollama may already be running as a background service
7072

7173
![Expose Ollama to the network](/api/images/docs/faq/ollama-setup-1.jpg)
74+
75+
## Privacy
76+
77+
When using local LLMs, your data never leaves your device. For more details on how Hyprnote handles data with different AI providers, see [AI Models & Data Privacy](/docs/faq/ai-models-and-privacy).

apps/web/content/docs/getting-started/3.quick-start.mdx

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ On first launch, grant microphone and system audio access when prompted. On macO
1212

1313
Go to Settings > Transcription and choose:
1414
- **Pro (recommended)**: Subscribe to Pro for curated cloud models that work out of the box
15-
- **Local**: Select a Whisper model (downloads automatically on first use)
16-
- **BYOK**: Enter your own API key for Deepgram, AssemblyAI, Gladia, OpenAI, or Soniox
15+
- **Local**: Select a Whisper model (downloads automatically on first use). See [Local Models](/docs/developers/local-models) for details
16+
- **BYOK**: Enter your own API key for Deepgram, AssemblyAI, Gladia, OpenAI, or Soniox. See [Better Transcription](/docs/pro/better-transcription) for provider comparison
1717

1818
## 3. Set Up AI
1919

2020
Go to Settings > Intelligence and choose:
2121
- **Pro (recommended)**: Subscribe to Pro for curated AI models
22-
- **Local**: Install [LM Studio](https://lmstudio.ai) or [Ollama](https://ollama.ai), start the server
22+
- **Local**: Install [LM Studio](https://lmstudio.ai) or [Ollama](https://ollama.ai), start the server. See the [Local LLM Setup guide](/docs/faq/local-llm-setup) for detailed instructions
2323
- **BYOK**: Enter your own API key for OpenAI, Anthropic, Google, or Mistral
2424

2525
## 4. Record Your First Meeting
@@ -35,4 +35,7 @@ Click "Enhance" to generate an AI summary from your notes and transcript.
3535

3636
## Next Steps
3737

38-
Explore [Templates](/templates) for custom summary formats, or join our [Discord](/discord) for help.
38+
- Explore [Templates](/templates) for custom summary formats
39+
- Learn all [Keyboard Shortcuts](/docs/faq/keyboard-shortcuts)
40+
- Read about [AI Models & Data Privacy](/docs/faq/ai-models-and-privacy)
41+
- Join our [Discord](/discord) for help

0 commit comments

Comments
 (0)