From 9f7d69be22f6fe9c498581e83df190cf450af40f Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Tue, 10 Feb 2026 00:14:05 +0000 Subject: [PATCH] docs: update technical documentation based on recent code changes Co-Authored-By: unknown <> --- apps/web/content/docs/developers/1.env.mdx | 42 +++++++++++-------- .../content/docs/developers/14.bug-report.mdx | 11 +++-- apps/web/content/docs/faq/1.features.mdx | 8 ++++ apps/web/content/docs/faq/5.support.mdx | 4 +- 4 files changed, 42 insertions(+), 23 deletions(-) diff --git a/apps/web/content/docs/developers/1.env.mdx b/apps/web/content/docs/developers/1.env.mdx index eb4f805336..aaccb88a2e 100644 --- a/apps/web/content/docs/developers/1.env.mdx +++ b/apps/web/content/docs/developers/1.env.mdx @@ -46,30 +46,36 @@ See `apps/web/package.json`, `apps/api/package.json`, and `apps/restate/package. # AI Server (apps/ai) -The AI server uses the `envy` crate for structured environment configuration. Create a `.env` file in `apps/ai/` with: +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: ```bash -PORT=3001 # default: 3001 -SENTRY_DSN="" # optional -POSTHOG_API_KEY="" # optional +PORT=3001 # default: 3001 +SENTRY_DSN="" # optional +POSTHOG_API_KEY="" # optional SUPABASE_URL="http://127.0.0.1:54321" SUPABASE_ANON_KEY="sb_publishable_..." # required -NANGO_API_KEY="" # required for calendar integration -NANGO_API_BASE="" # optional (defaults to Nango cloud) -STRIPE_SECRET_KEY="sk_..." # required for subscription -STRIPE_MONTHLY_PRICE_ID="" # required for subscription -STRIPE_YEARLY_PRICE_ID="" # required for subscription -OPENROUTER_API_KEY="sk-or-..." # required for LLM proxy -DEEPGRAM_API_KEY="" # optional STT provider -ASSEMBLYAI_API_KEY="" # optional STT provider -SONIOX_API_KEY="" # optional STT provider -FIREWORKS_API_KEY="" # optional STT provider -OPENAI_API_KEY="" # optional STT provider -GLADIA_API_KEY="" # optional STT provider -ELEVENLABS_API_KEY="" # optional STT provider +NANGO_API_KEY="" # required for calendar integration +NANGO_API_BASE="" # optional (defaults to Nango cloud) +STRIPE_SECRET_KEY="sk_..." # required for subscription +STRIPE_MONTHLY_PRICE_ID="" # required for subscription +STRIPE_YEARLY_PRICE_ID="" # required for subscription +OPENROUTER_API_KEY="sk-or-..." # required for LLM proxy +DEEPGRAM_API_KEY="" # optional STT provider +ASSEMBLYAI_API_KEY="" # optional STT provider +SONIOX_API_KEY="" # optional STT provider +FIREWORKS_API_KEY="" # optional STT provider +OPENAI_API_KEY="" # optional STT provider +GLADIA_API_KEY="" # optional STT provider +ELEVENLABS_API_KEY="" # optional STT provider +GITHUB_BOT_APP_ID="" # required for support chat +GITHUB_BOT_PRIVATE_KEY="" # required for support chat +GITHUB_BOT_INSTALLATION_ID="" # required for support chat +GITHUB_REPO_ID="" # required for support chat +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 when running the calendar and subscription APIs that were consolidated into the AI server. +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. # Stripe Webhook Service (apps/stripe) diff --git a/apps/web/content/docs/developers/14.bug-report.mdx b/apps/web/content/docs/developers/14.bug-report.mdx index 88ed2b6ce8..826c95d018 100644 --- a/apps/web/content/docs/developers/14.bug-report.mdx +++ b/apps/web/content/docs/developers/14.bug-report.mdx @@ -8,10 +8,13 @@ description: "How to report bugs and find log files for troubleshooting Hyprnote If you encounter any issues with Hyprnote, we'd love to hear about them! You can report bugs through: -- **GitHub Issues**: [github.com/hyprnote/hyprnote/issues](https://github.com/hyprnote/hyprnote/issues) +- **In-app support chat**: Click your profile icon in the sidebar and select **Report Bug** or **Suggest Feature**. This opens a support chat that automatically collects device information and submits issues on your behalf. +- **GitHub Issues**: [github.com/fastrepl/hyprnote/issues](https://github.com/fastrepl/hyprnote/issues) - **Discord**: Join our community for quick support and discussion -When reporting a bug, please include: +The in-app support chat is the recommended way to report bugs because it automatically attaches your platform, OS version, and app version to the report. + +When reporting a bug manually, please include: - Your operating system and version - Steps to reproduce the issue @@ -131,9 +134,9 @@ Do **not** delete: Still stuck? We're here to help: +- Use the **in-app support chat** (profile icon → Report Bug) - Join our [Discord community](https://discord.gg/hyprnote) -- Create a [GitHub issue](https://github.com/hyprnote/hyprnote/issues) -- Email us at support@hyprnote.com +- Create a [GitHub issue](https://github.com/fastrepl/hyprnote/issues) When reaching out, please include: diff --git a/apps/web/content/docs/faq/1.features.mdx b/apps/web/content/docs/faq/1.features.mdx index 010231ce98..ceba21c16a 100644 --- a/apps/web/content/docs/faq/1.features.mdx +++ b/apps/web/content/docs/faq/1.features.mdx @@ -54,6 +54,14 @@ The calendar tab (⌘ + ⇧ + C) supports week, Yes. If you previously ignored a calendar event, right-click on it in the sidebar timeline and select "Unignore" from the context menu to restore it. +## Can I create a note from the macOS dock? + +Yes. On macOS, right-click the Hyprnote icon in the Dock to see a context menu with a **New Note** option. Clicking it creates a new note and brings Hyprnote to the foreground. + +## Can I open the AI chat as a full tab? + +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 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 ⌘ + Z to restore the most recently deleted note before the undo window expires. diff --git a/apps/web/content/docs/faq/5.support.mdx b/apps/web/content/docs/faq/5.support.mdx index 74009e09dc..0c77f6853f 100644 --- a/apps/web/content/docs/faq/5.support.mdx +++ b/apps/web/content/docs/faq/5.support.mdx @@ -6,7 +6,9 @@ description: "Questions about getting help and support for Hyprnote." ## How do I get help if something isn't working? -You can reach our support team at support@hyprnote.com or join our Discord community for quick help. We also have comprehensive documentation at docs.hyprnote.com. +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. + +You can also reach us through our Discord community or by opening an issue on [GitHub](https://github.com/fastrepl/hyprnote/issues). ## Do you offer refunds?