magdev/wp-fedistream
1
Fork 0
Code Issues Pull Requests Actions Releases 12 Activity

docs: Fix markdown linting issues in user guide

Browse Source 
- Consistent table column separator widths
- Rename duplicate "Requirements" headings to be more specific

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Marco Grätsch
2026-01-28 23:56:13 +01:00
parent db67a17fd4
commit edfd19dea1
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
USERGUIDE.md
View File

@@ -66,7 +66,7 @@ After activation, configure FediStream through **FediStream > Settings**.
### General Settings ### General Settings
| Setting | Description | Default | | Setting | Description | Default |
|---------|-------------|---------| | --------- | ------------- | --------- |
| ActivityPub Integration | Enable Fediverse features for sharing releases | Enabled | | ActivityPub Integration | Enable Fediverse features for sharing releases | Enabled |
| WooCommerce Integration | Enable selling music (requires WooCommerce) | Disabled | | WooCommerce Integration | Enable selling music (requires WooCommerce) | Disabled |
| Max Upload Size | Maximum audio file size in MB | 50 MB | | 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 ### Artist Types
| Type | Description | | Type | Description |
|------|-------------| | ------ | ------------- |
| Solo | Individual musician | | Solo | Individual musician |
| Band | Group of musicians | | Band | Group of musicians |
| Duo | Two-person musical act | | Duo | Two-person musical act |
@@ -141,7 +141,7 @@ Albums organize your music into releases. They can be full albums, EPs, singles,
### Album Types ### Album Types
| Type | Description | Typical Track Count | | Type | Description | Typical Track Count |
|------|-------------|---------------------| | ------ | ------------- | --------------------- |
| Album | Full-length release | 8-15 tracks | | Album | Full-length release | 8-15 tracks |
| EP | Extended Play | 4-6 tracks | | EP | Extended Play | 4-6 tracks |
| Single | Single track release | 1-3 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 ### Audio File Guidelines
| Format | Quality | Recommended For | | Format | Quality | Recommended For |
|--------|---------|-----------------| | -------- | --------- | ----------------- |
| MP3 | 320kbps | Web streaming | | MP3 | 320kbps | Web streaming |
| FLAC | Lossless | Downloads, archival | | FLAC | Lossless | Downloads, archival |
| WAV | Uncompressed | Master files | | WAV | Uncompressed | Master files |
@@ -328,7 +328,7 @@ FediStream includes widgets for your sidebar or widget areas.
### Available Widgets ### Available Widgets
| Widget | Description | | Widget | Description |
|--------|-------------| | -------- | ------------- |
| Recent Releases | Displays latest album releases | | Recent Releases | Displays latest album releases |
| Popular Tracks | Shows most-played tracks | | Popular Tracks | Shows most-played tracks |
| Featured Artist | Highlights a specific artist | | 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. 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. 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 Types
| Activity | When Sent | | Activity | When Sent |
|----------|-----------| | ---------- | ----------- |
| Create | New album or track published | | Create | New album or track published |
| Update | Album or track updated | | Update | Album or track updated |
| Delete | Content removed | | 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. Sell your music directly through your WordPress site using WooCommerce.
### Requirements ### Requirements for WooCommerce Integration
- WooCommerce 10.0 or higher installed and activated - WooCommerce 10.0 or higher installed and activated
- WooCommerce integration enabled in FediStream settings - WooCommerce integration enabled in FediStream settings
@@ -409,7 +409,7 @@ Sell your music directly through your WordPress site using WooCommerce.
### Pricing Types ### Pricing Types
| Type | Description | | Type | Description |
|------|-------------| | ------ | ------------- |
| Fixed | Standard fixed price | | Fixed | Standard fixed price |
| Pay What You Want (PWYW) | Customer chooses price above minimum | | Pay What You Want (PWYW) | Customer chooses price above minimum |
| Name Your Price (NYP) | Customer sets any price (including free) | | 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 ### URL Slugs
| Content Type | URL Pattern | | Content Type | URL Pattern |
|--------------|-------------| | -------------- | ------------- |
| Artists | `/artists/{slug}/` | | Artists | `/artists/{slug}/` |
| Albums | `/albums/{slug}/` | | Albums | `/albums/{slug}/` |
| Tracks | `/tracks/{slug}/` | | Tracks | `/tracks/{slug}/` |
@@ -528,14 +528,14 @@ Notifications appear in the admin bar and can be configured for email delivery.
### User Roles ### User Roles
| Role | Capabilities | | Role | Capabilities |
|------|--------------| | ------ | -------------- |
| FediStream Artist | Manage own content, upload files, view own stats | | FediStream Artist | Manage own content, upload files, view own stats |
| FediStream Label | Manage all content, manage taxonomies, view all stats | | FediStream Label | Manage all content, manage taxonomies, view all stats |
### Keyboard Shortcuts (Player) ### Keyboard Shortcuts (Player)
| Key | Action | | Key | Action |
|-----|--------| | ----- | -------- |
| Space | Play/Pause | | Space | Play/Pause |
| Left Arrow | Previous track | | Left Arrow | Previous track |
| Right Arrow | Next track | | Right Arrow | Next track |