Skip to content

Speakr is a personal, self-hosted web application designed for transcribing audio recordings

Python

Add event extraction screenshot to documentation

Murtaza Nasirefccd3cb0d81
diff --git a/.github/workflows/docker-publish.yml b/.github/workflows/docker-publish.yml
index febecb55..1d2e0d85 100644
--- a/.github/workflows/docker-publish.yml
+++ b/.github/workflows/docker-publish.yml
@@ -1,11 +1,11 @@
name: Docker Build and Publish
on:
+ release:
+ types: [published]
push:
- branches: [ "master" ]
tags: [ 'v*.*.*' ]
- pull_request:
- branches: [ "master" ]
+ workflow_dispatch:
env:
# Use docker.io for Docker Hub if empty
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 8f7486ec..4b89dbef 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -1,8 +1,10 @@
name: Deploy Documentation
on:
+ release:
+ types: [published]
push:
- branches: [ master, main ]
+ tags: [ 'v*.*.*' ]
paths:
- 'docs/**'
- '.github/workflows/docs.yml'
diff --git a/docs/assets/images/screenshots/event extraction.png b/docs/assets/images/screenshots/event extraction.png
new file mode 100644
index 00000000..1f87f6ac
Binary files /dev/null and b/docs/assets/images/screenshots/event extraction.png differ
diff --git a/docs/index.md b/docs/index.md
index f6559656..43aab09e 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -119,6 +119,7 @@ Speakr is a powerful self-hosted transcription platform that helps you capture,
- **Improved UI** - Better mobile layouts and loading overlays across all pages
Previous release (v0.5.5):
+
- Full internationalization with multi-language support
- Enhanced audio processing at 128kbps for better accuracy
- Advanced filtering with date presets and multi-tag selection
diff --git a/docs/user-guide/transcripts.md b/docs/user-guide/transcripts.md
index d31c24f5..a37fe4b3 100644
--- a/docs/user-guide/transcripts.md
+++ b/docs/user-guide/transcripts.md
@@ -122,6 +122,8 @@ You can regenerate the summary with different settings if needed, which is usefu
When event extraction is enabled in your account settings, Speakr automatically identifies calendar-worthy events from your recordings during the summary generation process. This feature intelligently detects meetings, deadlines, appointments, and other time-sensitive items mentioned in your conversations.
+![Event Extraction](../assets/images/screenshots/event extraction.png)
+
### Viewing Extracted Events
After a recording is processed with event extraction enabled, an Events tab appears in the right panel if any events were detected. The tab shows a clean list of identified events, each displaying the event title, date, time, and description extracted from the conversation. Events are automatically parsed with intelligent date recognition that understands relative references like "next Tuesday" or "in two weeks" based on the recording date.