From 9ebc60a7156be23585482d014da33ec1214ae1fe Mon Sep 17 00:00:00 2001 From: Naomi Chopra Date: Sun, 11 May 2025 15:23:56 +0530 Subject: [PATCH] docs: add basic product docs and update layout (#8) --- apps/www/app/(home)/layout.tsx | 17 +- apps/www/app/docs/layout.tsx | 2 +- apps/www/app/layout.config.tsx | 14 -- .../docs/audio-video-transcription.mdx | 8 + .../www/content/docs/automatic-vocabulary.mdx | 8 + apps/www/content/docs/bring-your-own-key.mdx | 8 + .../www/content/docs/bring-your-own-model.mdx | 8 + apps/www/content/docs/context-awareness.mdx | 14 ++ apps/www/content/docs/contributing.mdx | 5 + apps/www/content/docs/custom-hotkeys.mdx | 22 +++ apps/www/content/docs/custom-prompts.mdx | 18 ++ apps/www/content/docs/custom-vocabulary.mdx | 17 ++ apps/www/content/docs/desktop-widget.mdx | 47 ++++++ apps/www/content/docs/getting-started.mdx | 6 + apps/www/content/docs/index.mdx | 154 +++++++++++++++++- apps/www/content/docs/inline-editing.mdx | 68 ++++++++ apps/www/content/docs/mcp-integrations.mdx | 8 + .../content/docs/meeting-transcription.mdx | 34 ++++ apps/www/content/docs/meta.json | 30 ++++ .../content/docs/multi-language-support.mdx | 7 + apps/www/content/docs/note-taking.mdx | 8 + apps/www/content/docs/test.mdx | 17 -- .../content/docs/transcription-history.mdx | 8 + apps/www/content/docs/voice-commands.mdx | 8 + apps/www/lib/source.ts | 7 + 25 files changed, 504 insertions(+), 39 deletions(-) create mode 100644 apps/www/content/docs/audio-video-transcription.mdx create mode 100644 apps/www/content/docs/automatic-vocabulary.mdx create mode 100644 apps/www/content/docs/bring-your-own-key.mdx create mode 100644 apps/www/content/docs/bring-your-own-model.mdx create mode 100644 apps/www/content/docs/context-awareness.mdx create mode 100644 apps/www/content/docs/contributing.mdx create mode 100644 apps/www/content/docs/custom-hotkeys.mdx create mode 100644 apps/www/content/docs/custom-prompts.mdx create mode 100644 apps/www/content/docs/custom-vocabulary.mdx create mode 100644 apps/www/content/docs/desktop-widget.mdx create mode 100644 apps/www/content/docs/getting-started.mdx create mode 100644 apps/www/content/docs/inline-editing.mdx create mode 100644 apps/www/content/docs/mcp-integrations.mdx create mode 100644 apps/www/content/docs/meeting-transcription.mdx create mode 100644 apps/www/content/docs/meta.json create mode 100644 apps/www/content/docs/multi-language-support.mdx create mode 100644 apps/www/content/docs/note-taking.mdx delete mode 100644 apps/www/content/docs/test.mdx create mode 100644 apps/www/content/docs/transcription-history.mdx create mode 100644 apps/www/content/docs/voice-commands.mdx diff --git a/apps/www/app/(home)/layout.tsx b/apps/www/app/(home)/layout.tsx index e28e447..b95a5e5 100644 --- a/apps/www/app/(home)/layout.tsx +++ b/apps/www/app/(home)/layout.tsx @@ -9,7 +9,22 @@ export default function Layout({ children: ReactNode; }): React.ReactElement { return ( - +
diff --git a/apps/www/app/docs/layout.tsx b/apps/www/app/docs/layout.tsx index a91d558..cda3749 100644 --- a/apps/www/app/docs/layout.tsx +++ b/apps/www/app/docs/layout.tsx @@ -5,7 +5,7 @@ import { source } from '@/lib/source'; export default function Layout({ children }: { children: ReactNode }) { return ( - + {children} ); diff --git a/apps/www/app/layout.config.tsx b/apps/www/app/layout.config.tsx index 2fd3058..40b2d1a 100644 --- a/apps/www/app/layout.config.tsx +++ b/apps/www/app/layout.config.tsx @@ -25,20 +25,6 @@ export const baseOptions: BaseLayoutProps = { ), }, links: [ - { - text: 'Docs', - url: '/docs', - }, - { - text: 'Contact', - url: '/contact', - active: 'nested-url', - }, - { - text: 'Changelog', - url: '/changelog', - active: 'nested-url', - }, { type: 'icon', url: '/community', diff --git a/apps/www/content/docs/audio-video-transcription.mdx b/apps/www/content/docs/audio-video-transcription.mdx new file mode 100644 index 0000000..eecab24 --- /dev/null +++ b/apps/www/content/docs/audio-video-transcription.mdx @@ -0,0 +1,8 @@ +--- +title: Audio/Video Transcription +description: Transcribe uploaded audio and video files into text +--- + +This feature is on the roadmap + +Amical will soon support transcription of audio and video files, allowing you to convert recorded content into text. diff --git a/apps/www/content/docs/automatic-vocabulary.mdx b/apps/www/content/docs/automatic-vocabulary.mdx new file mode 100644 index 0000000..be9f0c7 --- /dev/null +++ b/apps/www/content/docs/automatic-vocabulary.mdx @@ -0,0 +1,8 @@ +--- +title: Automatic Vocabulary +description: System adapts to your speech patterns and terminology over time +--- + +This feature is on the roadmap + +Amical will soon feature automatic vocabulary learning, allowing the system to adapt to your speech patterns and terminology over time. \ No newline at end of file diff --git a/apps/www/content/docs/bring-your-own-key.mdx b/apps/www/content/docs/bring-your-own-key.mdx new file mode 100644 index 0000000..43bc4b0 --- /dev/null +++ b/apps/www/content/docs/bring-your-own-key.mdx @@ -0,0 +1,8 @@ +--- +title: Bring Your Own Key +description: Use your own API keys for AI models within the app +--- + +This feature is on the roadmap + +Amical will soon support using your own API keys for AI models, giving you more control over your transcription service. diff --git a/apps/www/content/docs/bring-your-own-model.mdx b/apps/www/content/docs/bring-your-own-model.mdx new file mode 100644 index 0000000..538290e --- /dev/null +++ b/apps/www/content/docs/bring-your-own-model.mdx @@ -0,0 +1,8 @@ +--- +title: Bring Your Own Model +description: Point to any AI model within the app +--- + +This feature is on the roadmap + +Amical will soon allow you to use your own AI models for transcription, providing maximum flexibility and control. diff --git a/apps/www/content/docs/context-awareness.mdx b/apps/www/content/docs/context-awareness.mdx new file mode 100644 index 0000000..9836316 --- /dev/null +++ b/apps/www/content/docs/context-awareness.mdx @@ -0,0 +1,14 @@ +--- +title: Context Awareness +description: Intelligently adapt transcription based on the applications you're using +--- + +Amical's context awareness feature intelligently adapts transcription based on the applications you're using, providing more accurate and relevant results. + +## How It Works + +When you're using Amical, it automatically detects which application is currently active and adjusts its transcription behavior accordingly. This means: + +- Different formatting rules for different apps +- Specialized vocabulary recognition based on context +- Optimized transcription settings for each use case diff --git a/apps/www/content/docs/contributing.mdx b/apps/www/content/docs/contributing.mdx new file mode 100644 index 0000000..394c932 --- /dev/null +++ b/apps/www/content/docs/contributing.mdx @@ -0,0 +1,5 @@ +--- +title: Contributing +description: Guide to contributing to the Amical open source project +--- +TBD \ No newline at end of file diff --git a/apps/www/content/docs/custom-hotkeys.mdx b/apps/www/content/docs/custom-hotkeys.mdx new file mode 100644 index 0000000..5a39233 --- /dev/null +++ b/apps/www/content/docs/custom-hotkeys.mdx @@ -0,0 +1,22 @@ +--- +title: Custom Hotkeys +description: Configure keyboard shortcuts for all transcription actions +--- + +Amical allows you to configure custom keyboard shortcuts for all transcription actions, giving you complete control over your workflow. + +## Default Hotkeys + +By default, Amical comes with these keyboard shortcuts: + +- `fn`: Start/Stop transcription + +## Customizing Hotkeys + +You can customize any hotkey in the Amical preferences: + +1. Open Amical settings +2. Go to the "Hotkeys" section +3. Click on the action you want to modify +4. Press your desired key combination +5. Click "Save" to apply changes diff --git a/apps/www/content/docs/custom-prompts.mdx b/apps/www/content/docs/custom-prompts.mdx new file mode 100644 index 0000000..ea5eeef --- /dev/null +++ b/apps/www/content/docs/custom-prompts.mdx @@ -0,0 +1,18 @@ +--- +title: Custom Prompts +description: Custom prompts for AI to pre and post-process transcription +--- + +This feature is on the roadmap + +Amical will soon support custom prompts for AI to pre and post-process transcription, enabling specialized formatting and processing. + +## Planned Features + +### Prompt Types + +- Pre-processing +- Post-processing +- Formatting +- Summarization +- Custom actions diff --git a/apps/www/content/docs/custom-vocabulary.mdx b/apps/www/content/docs/custom-vocabulary.mdx new file mode 100644 index 0000000..01c157a --- /dev/null +++ b/apps/www/content/docs/custom-vocabulary.mdx @@ -0,0 +1,17 @@ +--- +title: Custom Vocabulary +description: Add custom terms to improve transcription accuracy for specialized content +--- + +This feature is on the roadmap + +Amical will soon allow you to add custom terms to improve transcription accuracy for specialized content. + + +## Use Cases + +- Technical terminology +- Industry-specific jargon +- Names and proper nouns +- Acronyms and abbreviations +- Brand names and products diff --git a/apps/www/content/docs/desktop-widget.mdx b/apps/www/content/docs/desktop-widget.mdx new file mode 100644 index 0000000..0faf9c8 --- /dev/null +++ b/apps/www/content/docs/desktop-widget.mdx @@ -0,0 +1,47 @@ +--- +title: Desktop Widget +description: Quick access to transcription controls without interrupting your workflow +--- + +Amical's desktop widget provides quick access to transcription controls without interrupting your workflow. + +## Features + +The desktop widget includes: + +- Start/Stop transcription button +- Current status indicator +- Language selector +- Quick settings access +- Minimize/Maximize controls + +## Using the Widget + +### Basic Controls + +- Click the microphone icon to start/stop transcription +- Use the language dropdown to switch languages +- Click the settings icon to access quick settings +- Drag the widget to reposition it on your screen + +### Widget States + +The widget shows different states: + +- 🟢 Active: Currently transcribing +- 🔴 Inactive: Ready to start +- 🟡 Processing: Processing audio +- ⚪ Paused: Temporarily paused + +## Customization + +You can customize the widget in the Amical preferences: + +1. Open Amical settings +2. Navigate to "Desktop Widget" +3. Adjust settings like: + - Widget size + - Opacity + - Always on top + - Auto-hide + - Position diff --git a/apps/www/content/docs/getting-started.mdx b/apps/www/content/docs/getting-started.mdx new file mode 100644 index 0000000..cdecd7e --- /dev/null +++ b/apps/www/content/docs/getting-started.mdx @@ -0,0 +1,6 @@ +--- +title: Getting Started +description: How to get started with Amical +--- + +Guide coming soon. diff --git a/apps/www/content/docs/index.mdx b/apps/www/content/docs/index.mdx index 986a7fa..340bd74 100644 --- a/apps/www/content/docs/index.mdx +++ b/apps/www/content/docs/index.mdx @@ -1,13 +1,155 @@ --- -title: Hello World -description: Your first document +title: What is Amical +description: Learn about Amical --- -Welcome to the docs! You can start writing documents in `/content/docs`. +Open Source Speech-to-Text App powered by Gen AI +Type 10x faster, no keyboard needed. Fast, Accurate, Context-aware and Private. -## What is Next? +Power of Amical lies in the fact that it is context aware based on where you are using the dictaion (tal,king to your cowerkers on slack, commenting on social media, talking to your friends, writing a formal email) so thats its as accurate as typing it your self, just 10x faster and formatted perfectly. + +## 🎯 Product Goals +* Full fledged desktop apps +* Quick access for users +* Context Aware +* Fast +* Accurate +* Voice activated workflows using MCP + +## ✨ Features +> ✔︎ - Done, ◑ - In Progress, ◯ - Planned + +📱 Apps +◑ Mac ◯ Windows ◯ Linux ◯ iOS ◯ Android + +⚡ Core Features - - + + Recognize context based on the apps being used in the background to customize transcription based on use case. + + + + Configure your own keyboard shortcuts for common transcription actions (start/stop, commands). + + + + A floating, easily accessible widget to control transcription without leaving your workflow. + + + + Support for multiple languages and dialects for global usability. + + + + Transcribe uploaded audio and video files into text. + + + + Add custom terms, such as names, technical terms, or slang, for better accuracy. + + + + Dynamically learn new words based on usage. + + + + Use your own API keys for AI models within the app. + + + + Point to any AI model within the app. + + +🔗 Integrations & Workflow + + + + Seamlessly integrate your apps via MCP for control and command. + + + + Control desktop apps and transcription processes via native and custom integrations. + + + + Framework and devkit to build your own integrations. + + + +🌟 Enhancements + + + + Inline editing of transcribed text via voice commands. + + + + Maintain an easily searchable history of transcribed texts, with export options. + + + + Take quick notes with voice within the app. + + + + Custom prompts for AI to pre and post-process transcription to support use cases like custom formatting, summaries, etc. + + + + Record live meetings with both mic and system audio for seamless transcription. + + + diff --git a/apps/www/content/docs/inline-editing.mdx b/apps/www/content/docs/inline-editing.mdx new file mode 100644 index 0000000..b13894a --- /dev/null +++ b/apps/www/content/docs/inline-editing.mdx @@ -0,0 +1,68 @@ +--- +title: Inline Editing +description: Edit transcribed text via voice commands +--- + +This feature is on the roadmap + +Amical will soon support inline editing of transcribed text through voice commands, making it easier to refine and perfect your transcriptions. + +## Planned Features + +### Editing Commands + +- Text insertion +- Text deletion +- Text replacement +- Formatting +- Navigation + +### Voice Commands + +- "Insert text" +- "Delete word" +- "Replace phrase" +- "Format as" +- "Move cursor" + +## How It Will Work + +1. Start transcription +2. Use voice commands +3. Edit text +4. Review changes +5. Save final version + +## Editing Capabilities + +### Basic Editing +- Insert text +- Delete text +- Replace text +- Move cursor +- Select text + +### Advanced Editing +- Format text +- Apply styles +- Insert special characters +- Handle lists +- Manage paragraphs + +## Best Practices (Coming Soon) + +- Use clear commands +- Review changes +- Save frequently +- Use formatting +- Check accuracy + +## Integration + +This feature will work with: + +- Text editors +- Word processors +- Note-taking apps +- Email clients +- Custom applications diff --git a/apps/www/content/docs/mcp-integrations.mdx b/apps/www/content/docs/mcp-integrations.mdx new file mode 100644 index 0000000..8b9ae2a --- /dev/null +++ b/apps/www/content/docs/mcp-integrations.mdx @@ -0,0 +1,8 @@ +--- +title: MCP Integrations +description: Seamlessly integrate your apps via MCP for control and command +--- + +This feature is on the roadmap + +Amical will soon support MCP (Model Control Protocol) integrations, allowing seamless control and command of your applications. diff --git a/apps/www/content/docs/meeting-transcription.mdx b/apps/www/content/docs/meeting-transcription.mdx new file mode 100644 index 0000000..b260133 --- /dev/null +++ b/apps/www/content/docs/meeting-transcription.mdx @@ -0,0 +1,34 @@ +--- +title: Meeting Transcription +description: Record live meetings with both mic and system audio +--- + +This feature is on the roadmap + +Amical will soon support recording live meetings with both microphone and system audio for seamless transcription. + +## Planned Features + +### Audio Capture + +- Microphone input +- System audio +- Mixed audio +- Multiple sources +- Quality control + +### Transcription Features + +- Real-time transcription +- Speaker detection +- Timestamp markers +- Action items +- Summary generation + +## How It Will Work + +1. Start meeting +2. Capture audio +3. Transcribe in real-time +4. Process content +5. Export results diff --git a/apps/www/content/docs/meta.json b/apps/www/content/docs/meta.json new file mode 100644 index 0000000..79dedca --- /dev/null +++ b/apps/www/content/docs/meta.json @@ -0,0 +1,30 @@ +{ + "pages": [ + "---Getting Started---", + "index", + "getting-started", + "---Core Features---", + "context-awareness", + "custom-hotkeys", + "desktop-widget", + "multi-language-support", + "audio-video-transcription", + "custom-vocabulary", + "automatic-vocabulary", + "bring-your-own-key", + "bring-your-own-model", + "---Integrations---", + "mcp-integrations", + "voice-commands", + "---Enhancements---", + "inline-editing", + "transcription-history", + "note-taking", + "custom-prompts", + "meeting-transcription", + "---Open Source---", + "contributing", + "[Heart][Sponsoring](https://github.com/sponsors/amicalhq)" + ] +} + diff --git a/apps/www/content/docs/multi-language-support.mdx b/apps/www/content/docs/multi-language-support.mdx new file mode 100644 index 0000000..32e7163 --- /dev/null +++ b/apps/www/content/docs/multi-language-support.mdx @@ -0,0 +1,7 @@ +--- +title: Multi-Language +description: Support for multiple languages and dialects for global usability +--- + +Amical supports multiple languages and dialects, making it accessible to users worldwide. +important sessions \ No newline at end of file diff --git a/apps/www/content/docs/note-taking.mdx b/apps/www/content/docs/note-taking.mdx new file mode 100644 index 0000000..34a701a --- /dev/null +++ b/apps/www/content/docs/note-taking.mdx @@ -0,0 +1,8 @@ +--- +title: Note Taking +description: Take quick notes with voice within the app +--- + +This feature is on the roadmap + +Amical will soon include a dedicated note-taking feature, allowing you to quickly capture and organize your thoughts through voice. diff --git a/apps/www/content/docs/test.mdx b/apps/www/content/docs/test.mdx deleted file mode 100644 index d1ee3a8..0000000 --- a/apps/www/content/docs/test.mdx +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Components -description: Components ---- - -## Code Block - -```js -console.log('Hello World'); -``` - -## Cards - - - - - diff --git a/apps/www/content/docs/transcription-history.mdx b/apps/www/content/docs/transcription-history.mdx new file mode 100644 index 0000000..d432bea --- /dev/null +++ b/apps/www/content/docs/transcription-history.mdx @@ -0,0 +1,8 @@ +--- +title: Transcription History +description: Maintain an easily searchable history of transcribed texts +--- + +This feature is on the roadmap + +Amical will soon maintain an easily searchable history of your transcribed texts, with comprehensive export options. diff --git a/apps/www/content/docs/voice-commands.mdx b/apps/www/content/docs/voice-commands.mdx new file mode 100644 index 0000000..d8059ec --- /dev/null +++ b/apps/www/content/docs/voice-commands.mdx @@ -0,0 +1,8 @@ +--- +title: Voice Commands +description: Control desktop apps and transcription processes via voice +--- + +This feature is on the roadmap + +Amical will soon support voice commands to control desktop apps and transcription processes through native and custom integrations. diff --git a/apps/www/lib/source.ts b/apps/www/lib/source.ts index dedc4be..c7ab4e1 100644 --- a/apps/www/lib/source.ts +++ b/apps/www/lib/source.ts @@ -1,9 +1,16 @@ import { docs } from '@/.source'; import { loader } from 'fumadocs-core/source'; +import { icons } from 'lucide-react'; +import { createElement } from 'react'; // See https://fumadocs.vercel.app/docs/headless/source-api for more info export const source = loader({ // it assigns a URL to your pages baseUrl: '/docs', + icon(icon) { + if (icon && icon in icons) + return createElement(icons[icon as keyof typeof icons]); + }, + source: docs.toFumadocsSource(), });