docs: add basic product docs and update layout (#8)
This commit is contained in:
Naomi Chopra
GitHub
parent
85e1227885
commit
9ebc60a715
25 changed files with 504 additions and 39 deletions
|
|
@ -9,7 +9,22 @@ export default function Layout({
|
|||
children: ReactNode;
|
||||
}): React.ReactElement {
|
||||
return (
|
||||
<HomeLayout {...baseOptions}>
|
||||
<HomeLayout {...baseOptions} links={[
|
||||
{
|
||||
text: 'Docs',
|
||||
url: '/docs',
|
||||
},
|
||||
{
|
||||
text: 'Contact',
|
||||
url: '/contact',
|
||||
active: 'nested-url',
|
||||
},
|
||||
{
|
||||
text: 'Changelog',
|
||||
url: '/changelog',
|
||||
active: 'nested-url',
|
||||
},
|
||||
]}>
|
||||
<div className="fixed inset-0 pointer-events-none">
|
||||
</div>
|
||||
<div className="relative min-h-screen w-full">
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ import { source } from '@/lib/source';
|
|||
|
||||
export default function Layout({ children }: { children: ReactNode }) {
|
||||
return (
|
||||
<DocsLayout tree={source.pageTree} {...baseOptions}>
|
||||
<DocsLayout tree={source.pageTree} {...baseOptions} >
|
||||
{children}
|
||||
</DocsLayout>
|
||||
);
|
||||
|
|
|
|||
|
|
@ -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',
|
||||
|
|
|
|||
8
apps/www/content/docs/audio-video-transcription.mdx
Normal file
8
apps/www/content/docs/audio-video-transcription.mdx
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
title: Audio/Video Transcription
|
||||
description: Transcribe uploaded audio and video files into text
|
||||
---
|
||||
|
||||
<Callout title="Coming soon">This feature is on the roadmap</Callout>
|
||||
|
||||
Amical will soon support transcription of audio and video files, allowing you to convert recorded content into text.
|
||||
8
apps/www/content/docs/automatic-vocabulary.mdx
Normal file
8
apps/www/content/docs/automatic-vocabulary.mdx
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
title: Automatic Vocabulary
|
||||
description: System adapts to your speech patterns and terminology over time
|
||||
---
|
||||
|
||||
<Callout title="Coming soon">This feature is on the roadmap</Callout>
|
||||
|
||||
Amical will soon feature automatic vocabulary learning, allowing the system to adapt to your speech patterns and terminology over time.
|
||||
8
apps/www/content/docs/bring-your-own-key.mdx
Normal file
8
apps/www/content/docs/bring-your-own-key.mdx
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
title: Bring Your Own Key
|
||||
description: Use your own API keys for AI models within the app
|
||||
---
|
||||
|
||||
<Callout title="Coming soon">This feature is on the roadmap</Callout>
|
||||
|
||||
Amical will soon support using your own API keys for AI models, giving you more control over your transcription service.
|
||||
8
apps/www/content/docs/bring-your-own-model.mdx
Normal file
8
apps/www/content/docs/bring-your-own-model.mdx
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
title: Bring Your Own Model
|
||||
description: Point to any AI model within the app
|
||||
---
|
||||
|
||||
<Callout title="Coming soon">This feature is on the roadmap</Callout>
|
||||
|
||||
Amical will soon allow you to use your own AI models for transcription, providing maximum flexibility and control.
|
||||
14
apps/www/content/docs/context-awareness.mdx
Normal file
14
apps/www/content/docs/context-awareness.mdx
Normal file
|
|
@ -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
|
||||
5
apps/www/content/docs/contributing.mdx
Normal file
5
apps/www/content/docs/contributing.mdx
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: Contributing
|
||||
description: Guide to contributing to the Amical open source project
|
||||
---
|
||||
TBD
|
||||
22
apps/www/content/docs/custom-hotkeys.mdx
Normal file
22
apps/www/content/docs/custom-hotkeys.mdx
Normal file
|
|
@ -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
|
||||
18
apps/www/content/docs/custom-prompts.mdx
Normal file
18
apps/www/content/docs/custom-prompts.mdx
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
title: Custom Prompts
|
||||
description: Custom prompts for AI to pre and post-process transcription
|
||||
---
|
||||
|
||||
<Callout title="Coming soon">This feature is on the roadmap</Callout>
|
||||
|
||||
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
|
||||
17
apps/www/content/docs/custom-vocabulary.mdx
Normal file
17
apps/www/content/docs/custom-vocabulary.mdx
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
---
|
||||
title: Custom Vocabulary
|
||||
description: Add custom terms to improve transcription accuracy for specialized content
|
||||
---
|
||||
|
||||
<Callout title="Coming soon">This feature is on the roadmap</Callout>
|
||||
|
||||
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
|
||||
47
apps/www/content/docs/desktop-widget.mdx
Normal file
47
apps/www/content/docs/desktop-widget.mdx
Normal file
|
|
@ -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
|
||||
6
apps/www/content/docs/getting-started.mdx
Normal file
6
apps/www/content/docs/getting-started.mdx
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
title: Getting Started
|
||||
description: How to get started with Amical
|
||||
---
|
||||
|
||||
Guide coming soon.
|
||||
|
|
@ -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
|
||||
|
||||
<Cards>
|
||||
<Card title="Learn more about Next.js" href="https://nextjs.org/docs" />
|
||||
<Card title="Learn more about Fumadocs" href="https://fumadocs.vercel.app" />
|
||||
<Card
|
||||
href="/docs/context-awareness"
|
||||
title="Context Awareness ◑"
|
||||
>
|
||||
Recognize context based on the apps being used in the background to customize transcription based on use case.
|
||||
</Card>
|
||||
|
||||
<Card
|
||||
href="/docs/custom-hotkeys"
|
||||
title="Custom Hotkeys ◑"
|
||||
>
|
||||
Configure your own keyboard shortcuts for common transcription actions (start/stop, commands).
|
||||
</Card>
|
||||
|
||||
<Card
|
||||
href="/docs/desktop-widget"
|
||||
title="Desktop Widget ◑"
|
||||
>
|
||||
A floating, easily accessible widget to control transcription without leaving your workflow.
|
||||
</Card>
|
||||
|
||||
<Card
|
||||
href="/docs/multi-language"
|
||||
title="Multi-Language Support ◑"
|
||||
>
|
||||
Support for multiple languages and dialects for global usability.
|
||||
</Card>
|
||||
|
||||
<Card
|
||||
href="/docs/audio-video-transcription"
|
||||
title="Audio/Video Transcription ◯"
|
||||
>
|
||||
Transcribe uploaded audio and video files into text.
|
||||
</Card>
|
||||
|
||||
<Card
|
||||
href="/docs/custom-vocabulary"
|
||||
title="Custom Vocabulary ◯"
|
||||
>
|
||||
Add custom terms, such as names, technical terms, or slang, for better accuracy.
|
||||
</Card>
|
||||
|
||||
<Card
|
||||
href="/docs/automatic-vocabulary"
|
||||
title="Automatic Vocabulary ◯"
|
||||
>
|
||||
Dynamically learn new words based on usage.
|
||||
</Card>
|
||||
|
||||
<Card
|
||||
href="/docs/bring-your-own-key"
|
||||
title="Bring Your Own Key ◯"
|
||||
>
|
||||
Use your own API keys for AI models within the app.
|
||||
</Card>
|
||||
|
||||
<Card
|
||||
href="/docs/bring-your-own-model"
|
||||
title="Bring Your Own Model ◯"
|
||||
>
|
||||
Point to any AI model within the app.
|
||||
</Card>
|
||||
</Cards>
|
||||
|
||||
🔗 Integrations & Workflow
|
||||
|
||||
<Cards>
|
||||
<Card
|
||||
href="/docs/mcp-integrations"
|
||||
title="MCP Integrations ◯"
|
||||
>
|
||||
Seamlessly integrate your apps via MCP for control and command.
|
||||
</Card>
|
||||
|
||||
<Card
|
||||
href="/docs/voice-commands"
|
||||
title="Voice Commands ◯"
|
||||
>
|
||||
Control desktop apps and transcription processes via native and custom integrations.
|
||||
</Card>
|
||||
|
||||
<Card
|
||||
href="/docs/integration-framework"
|
||||
title="Integration Framework ◯"
|
||||
>
|
||||
Framework and devkit to build your own integrations.
|
||||
</Card>
|
||||
</Cards>
|
||||
|
||||
🌟 Enhancements
|
||||
|
||||
<Cards>
|
||||
<Card
|
||||
href="/docs/text-editing"
|
||||
title="Text Editing ◯"
|
||||
>
|
||||
Inline editing of transcribed text via voice commands.
|
||||
</Card>
|
||||
|
||||
<Card
|
||||
href="/docs/transcription-history"
|
||||
title="Transcription History ◯"
|
||||
>
|
||||
Maintain an easily searchable history of transcribed texts, with export options.
|
||||
</Card>
|
||||
|
||||
<Card
|
||||
href="/docs/note-taking"
|
||||
title="Note Taking ◯"
|
||||
>
|
||||
Take quick notes with voice within the app.
|
||||
</Card>
|
||||
|
||||
<Card
|
||||
href="/docs/custom-prompts"
|
||||
title="Custom Prompts ◯"
|
||||
>
|
||||
Custom prompts for AI to pre and post-process transcription to support use cases like custom formatting, summaries, etc.
|
||||
</Card>
|
||||
|
||||
<Card
|
||||
href="/docs/meeting-transcription"
|
||||
title="Meeting Transcription ◯"
|
||||
>
|
||||
Record live meetings with both mic and system audio for seamless transcription.
|
||||
</Card>
|
||||
</Cards>
|
||||
|
||||
|
|
|
|||
68
apps/www/content/docs/inline-editing.mdx
Normal file
68
apps/www/content/docs/inline-editing.mdx
Normal file
|
|
@ -0,0 +1,68 @@
|
|||
---
|
||||
title: Inline Editing
|
||||
description: Edit transcribed text via voice commands
|
||||
---
|
||||
|
||||
<Callout title="Coming soon">This feature is on the roadmap</Callout>
|
||||
|
||||
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
|
||||
8
apps/www/content/docs/mcp-integrations.mdx
Normal file
8
apps/www/content/docs/mcp-integrations.mdx
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
title: MCP Integrations
|
||||
description: Seamlessly integrate your apps via MCP for control and command
|
||||
---
|
||||
|
||||
<Callout title="Coming soon">This feature is on the roadmap</Callout>
|
||||
|
||||
Amical will soon support MCP (Model Control Protocol) integrations, allowing seamless control and command of your applications.
|
||||
34
apps/www/content/docs/meeting-transcription.mdx
Normal file
34
apps/www/content/docs/meeting-transcription.mdx
Normal file
|
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
title: Meeting Transcription
|
||||
description: Record live meetings with both mic and system audio
|
||||
---
|
||||
|
||||
<Callout title="Coming soon">This feature is on the roadmap</Callout>
|
||||
|
||||
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
|
||||
30
apps/www/content/docs/meta.json
Normal file
30
apps/www/content/docs/meta.json
Normal file
|
|
@ -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)"
|
||||
]
|
||||
}
|
||||
|
||||
7
apps/www/content/docs/multi-language-support.mdx
Normal file
7
apps/www/content/docs/multi-language-support.mdx
Normal file
|
|
@ -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
|
||||
8
apps/www/content/docs/note-taking.mdx
Normal file
8
apps/www/content/docs/note-taking.mdx
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
title: Note Taking
|
||||
description: Take quick notes with voice within the app
|
||||
---
|
||||
|
||||
<Callout title="Coming soon">This feature is on the roadmap</Callout>
|
||||
|
||||
Amical will soon include a dedicated note-taking feature, allowing you to quickly capture and organize your thoughts through voice.
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
---
|
||||
title: Components
|
||||
description: Components
|
||||
---
|
||||
|
||||
## Code Block
|
||||
|
||||
```js
|
||||
console.log('Hello World');
|
||||
```
|
||||
|
||||
## Cards
|
||||
|
||||
<Cards>
|
||||
<Card title="Learn more about Next.js" href="https://nextjs.org/docs" />
|
||||
<Card title="Learn more about Fumadocs" href="https://fumadocs.vercel.app" />
|
||||
</Cards>
|
||||
8
apps/www/content/docs/transcription-history.mdx
Normal file
8
apps/www/content/docs/transcription-history.mdx
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
title: Transcription History
|
||||
description: Maintain an easily searchable history of transcribed texts
|
||||
---
|
||||
|
||||
<Callout title="Coming soon">This feature is on the roadmap</Callout>
|
||||
|
||||
Amical will soon maintain an easily searchable history of your transcribed texts, with comprehensive export options.
|
||||
8
apps/www/content/docs/voice-commands.mdx
Normal file
8
apps/www/content/docs/voice-commands.mdx
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
title: Voice Commands
|
||||
description: Control desktop apps and transcription processes via voice
|
||||
---
|
||||
|
||||
<Callout title="Coming soon">This feature is on the roadmap</Callout>
|
||||
|
||||
Amical will soon support voice commands to control desktop apps and transcription processes through native and custom integrations.
|
||||
|
|
@ -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(),
|
||||
});
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue