Skip to content

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

Python

Fix documentation build errors with broken links and missing screenshots

Murtaza Nasir66b1e9fb4bb3
diff --git a/docs/index.md b/docs/index.md
index d0d84284..532ceaa7 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -15,7 +15,7 @@ Speakr is a powerful self-hosted transcription platform that helps you capture,
**Key Environment Variables:** `ENABLE_INTERNAL_SHARING`, `SHOW_USERNAMES_IN_UI`, `USERS_CAN_DELETE`, `ENABLE_AUTO_DELETION`, `GLOBAL_RETENTION_DAYS`, `ENABLE_AUTO_EXPORT`, `ENABLE_PUBLIC_SHARING`
- See the [configuration guide](getting-started/installation.md#configuration-updates) for complete setup instructions. [View full release notes](https://github.com/murtaza-nasir/speakr/releases/tag/v0.5.9)
+ See the [configuration guide](getting-started/installation.md#step-3-environment-configuration) for complete setup instructions. [View full release notes](https://github.com/murtaza-nasir/speakr/releases/tag/v0.5.9)
## Quick Navigation
@@ -134,7 +134,7 @@ Experience seamless bidirectional synchronization between your audio and transcr
Learn more about [audio synchronization features](user-guide/transcripts.md#audio-synchronization-and-follow-mode) in the user guide.
!!! tip "Transform Your Recordings with Custom Tag Prompts"
- Tags aren't just for organization - they transform content. Create a "Recipe" tag to convert cooking narration into formatted recipes. Use "Study Notes" tags to turn lecture recordings into organized outlines. Stack tags like "Client Meeting" + "Legal Review" for combined analysis. Learn more in the [Custom Prompts guide](admin-guide/prompts#creative-tag-prompt-use-cases).
+ Tags aren't just for organization - they transform content. Create a "Recipe" tag to convert cooking narration into formatted recipes. Use "Study Notes" tags to turn lecture recordings into organized outlines. Stack tags like "Client Meeting" + "Legal Review" for combined analysis. Learn more in the [Custom Prompts guide](admin-guide/prompts.md#creative-tag-prompt-use-cases).
## Latest Updates
@@ -153,7 +153,7 @@ Learn more about [audio synchronization features](user-guide/transcripts.md#audi
- **UI/UX Enhancements** - Compact controls, inline editing, unified toast notifications, improved badges
- **Enhanced Internationalization** - 29 new tooltip translations across all languages (EN, DE, ES, FR, ZH)
- **Required `.env` variables:** See [configuration guide](getting-started/installation.md#configuration-updates)
+ **Required `.env` variables:** See [configuration guide](getting-started/installation.md#step-3-environment-configuration)
Previous release (v0.5.8):
diff --git a/docs/user-guide/sharing.md b/docs/user-guide/sharing.md
index 75a2055d..5330f12c 100644
--- a/docs/user-guide/sharing.md
+++ b/docs/user-guide/sharing.md
@@ -23,7 +23,7 @@ Your Speakr administrator must enable internal sharing before this feature becom
### Sharing a Recording with Another User
-![Share with User Modal](../assets/images/screenshots/share-with-user.png)
+![Share with User Modal](../assets/images/screenshots/Share modal.png)
When viewing any recording you own, look for the blue users icon button in the toolbar. Clicking this opens the share modal where you can search for colleagues and configure access permissions.
@@ -41,7 +41,7 @@ To share with view-only access, simply search for the user and click their name
### Managing Your Shares
-![Manage Shares Modal](../assets/images/screenshots/manage-shares.png)
+![Manage Shares Modal](../assets/images/screenshots/Share modal.png)
The unified share modal shows everyone who has access to a recording, making it easy to track and control sharing. Each entry displays the recipient's name, their permissions level, and when you granted access. The red user-times icon lets you instantly revoke access when collaboration ends or circumstances change.