From edfd19dea1273c313e302066a5dc9b8e68cb7a47 Mon Sep 17 00:00:00 2001 From: magdev Date: Wed, 28 Jan 2026 23:56:13 +0100 Subject: [PATCH] docs: Fix markdown linting issues in user guide - Consistent table column separator widths - Rename duplicate "Requirements" headings to be more specific Co-Authored-By: Claude Opus 4.5 --- USERGUIDE.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/USERGUIDE.md b/USERGUIDE.md index 6d22305..bfb6460 100644 --- a/USERGUIDE.md +++ b/USERGUIDE.md @@ -66,7 +66,7 @@ After activation, configure FediStream through **FediStream > Settings**. ### General Settings | Setting | Description | Default | -|---------|-------------|---------| +| --------- | ------------- | --------- | | ActivityPub Integration | Enable Fediverse features for sharing releases | Enabled | | WooCommerce Integration | Enable selling music (requires WooCommerce) | Disabled | | Max Upload Size | Maximum audio file size in MB | 50 MB | @@ -110,7 +110,7 @@ Artists represent musicians, bands, duos, or collectives. Each artist can have t ### Artist Types | Type | Description | -|------|-------------| +| ------ | ------------- | | Solo | Individual musician | | Band | Group of musicians | | Duo | Two-person musical act | @@ -141,7 +141,7 @@ Albums organize your music into releases. They can be full albums, EPs, singles, ### Album Types | Type | Description | Typical Track Count | -|------|-------------|---------------------| +| ------ | ------------- | --------------------- | | Album | Full-length release | 8-15 tracks | | EP | Extended Play | 4-6 tracks | | Single | Single track release | 1-3 tracks | @@ -178,7 +178,7 @@ Tracks are the individual songs or audio files in your library. ### Audio File Guidelines | Format | Quality | Recommended For | -|--------|---------|-----------------| +| -------- | --------- | ----------------- | | MP3 | 320kbps | Web streaming | | FLAC | Lossless | Downloads, archival | | WAV | Uncompressed | Master files | @@ -328,7 +328,7 @@ FediStream includes widgets for your sidebar or widget areas. ### Available Widgets | Widget | Description | -|--------|-------------| +| -------- | ------------- | | Recent Releases | Displays latest album releases | | Popular Tracks | Shows most-played tracks | | Featured Artist | Highlights a specific artist | @@ -348,7 +348,7 @@ FediStream includes widgets for your sidebar or widget areas. FediStream integrates with the Fediverse through ActivityPub, allowing your artists to be followed from Mastodon, Pixelfed, and other platforms. -### Requirements +### Requirements for ActivityPub integration Install and activate the [ActivityPub plugin](https://wordpress.org/plugins/activitypub/) from WordPress.org. @@ -370,7 +370,7 @@ https://your-site.com/.well-known/webfinger?resource=acct:artist-name@your-site. ### Activity Types | Activity | When Sent | -|----------|-----------| +| ---------- | ----------- | | Create | New album or track published | | Update | Album or track updated | | Delete | Content removed | @@ -386,7 +386,7 @@ Artist followers are displayed on the artist's admin page under the Followers me Sell your music directly through your WordPress site using WooCommerce. -### Requirements +### Requirements for WooCommerce Integration - WooCommerce 10.0 or higher installed and activated - WooCommerce integration enabled in FediStream settings @@ -409,7 +409,7 @@ Sell your music directly through your WordPress site using WooCommerce. ### Pricing Types | Type | Description | -|------|-------------| +| ------ | ------------- | | Fixed | Standard fixed price | | Pay What You Want (PWYW) | Customer chooses price above minimum | | Name Your Price (NYP) | Customer sets any price (including free) | @@ -517,7 +517,7 @@ Notifications appear in the admin bar and can be configured for email delivery. ### URL Slugs | Content Type | URL Pattern | -|--------------|-------------| +| -------------- | ------------- | | Artists | `/artists/{slug}/` | | Albums | `/albums/{slug}/` | | Tracks | `/tracks/{slug}/` | @@ -528,14 +528,14 @@ Notifications appear in the admin bar and can be configured for email delivery. ### User Roles | Role | Capabilities | -|------|--------------| +| ------ | -------------- | | FediStream Artist | Manage own content, upload files, view own stats | | FediStream Label | Manage all content, manage taxonomies, view all stats | ### Keyboard Shortcuts (Player) | Key | Action | -|-----|--------| +| ----- | -------- | | Space | Play/Pause | | Left Arrow | Previous track | | Right Arrow | Next track |