saulteafarmer/castopod
1
0
Fork 0
mirror of https://code.castopod.org/adaures/castopod synced 2025-04-19 13:01:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update docs with typo fixes

Browse Source
This commit is contained in:
Paul Cutler 2025-02-27 15:48:42 +00:00 committed by Yassine Doghri
parent 93b4741333
commit f8fb25f52d
4 changed files with 36 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/src/content/docs/en/user-guide/instance/podcast.mdx
View File

@ -98,7 +98,7 @@ To learn more about Fediverse integration, visit the
### Podcast banner ### Podcast banner
Upload a banner image to be displayed at the top of your podcast's home page. Upload a banner image to be displayed at the top of your podcast's home page.
The banner must have a 3:1 ration and be at least 1500px wide. The banner must have a 3:1 ratio and be at least 1500px wide.
### Premium ### Premium

2
docs/src/content/docs/en/user-guide/instance/users.mdx
View File

@ -4,7 +4,7 @@ title: Users
Roles and permissions in Castopod are defined in two ways, **Instance** users Roles and permissions in Castopod are defined in two ways, **Instance** users
and [**Podcast**. contributors](../podcast/contributors). For a detailed list of and [**Podcast**. contributors](../podcast/contributors). For a detailed list of
permissions, view he [Auth](../../getting-started/auth) page. permissions, view the [Auth](../../getting-started/auth) page.
## Adding a User to the instance ## Adding a User to the instance

25
docs/src/content/docs/en/user-guide/podcast/episodes.mdx
View File

@ -2,6 +2,8 @@
title: Episodes title: Episodes
--- ---
import { Aside } from "@astrojs/starlight/components";
From the left hand navigation, click **Episodes** and the menu will expand to From the left hand navigation, click **Episodes** and the menu will expand to
**All Episodes** and **New Episode**. **All Episodes** and **New Episode**.
@ -52,8 +54,12 @@ displaying the status of creating the clip. Refresh the page to see if it's
`Running` or completed. You may need to be patient depending on the length of `Running` or completed. You may need to be patient depending on the length of
the clip. the clip.
:::note To create video clips and soundbites, your server must have `FFMPEG` <Aside>
installed and a transcript. :::
To create video clips and soundbites, your server must have `FFMPEG` installed
and a transcript.
</Aside>
## Create episode ## Create episode
@ -149,3 +155,18 @@ Press `Publish` to finish.
Your RSS feed will be automatically updated with your episode information and Your RSS feed will be automatically updated with your episode information and
listeners who subscribe will be notified of a new episode. Congratulations on listeners who subscribe will be notified of a new episode. Congratulations on
publishing your first episode! publishing your first episode!
## Editing an episode
You can edit an episode before or after it is published. You can change any of
the fields, including uploading a new episode, updating the show notes, or
updating the transcripts or chapters. Select the episode you want to edit and
choose `Edit Episode`. You can change just one field or multiple fields at the
same time. After you have made the changes, press `Save Episode` in the upper
right corner to finalize the changes.
You can also edit the publication for the episode. Choose the episode again, and
press `Edit Publication` in the upper right hand corner. Update the announcement
post or publication date. When complete, press `Edit publication`. You can also
choose to cancel the publication and it won't be published but will not be
deleted.

16
docs/src/content/docs/en/user-guide/website/index.mdx
View File

@ -2,15 +2,17 @@
title: Podcast Home Page title: Podcast Home Page
--- ---
import { Aside } from "@astrojs/starlight/components";
The podcast home page is your landing page for your listeners to view episode The podcast home page is your landing page for your listeners to view episode
announcements, messages, episodes, and links to where to find your podcast. If announcements, messages, episodes, and links to where to find your podcast. If
you have only one podcast, your users will be automatically redirected from your you have only one podcast, your users will be automatically redirected from your
top level domain, such as `www.yourpodcast.com`, to the podcast page at top level domain, such as `www.yourpodcast.com`, to the podcast page at
`www.yourpodcast.com/yourpodcasthandle`. `www.yourpodcast.com/@yourpodcasthandle`.
If you are hosting multiple podcasts, your top level page will display the If you are hosting multiple podcasts, your top level page will display the
artwork for each podcast. Clicking on the podcast artwork will take you to your artwork for each podcast. Clicking on the podcast artwork will take you to your
podcast page at `www.yourpodcast.com/yourpodcasthandle`. podcast page at `www.yourpodcast.com/@yourpodcasthandle`.
## Home Page ## Home Page
@ -20,9 +22,13 @@ if you have any new notifications, and the user who is logged in. You can click
on the user for quick access to your account, changing your password, or to log on the user for quick access to your account, changing your password, or to log
out. out.
:::note If you have multiple podcasts, you can click the user dropdown to switch <Aside>
to choose which podcast to interact with. If your account has access to two or
more podcasts, pay attention to which podcast is broadcasting messages! ::: If you have multiple podcasts, you can click the user dropdown to switch to
choose which podcast to interact with. If your account has access to two or more
podcasts, pay attention to which podcast is broadcasting messages!
</Aside>
Listeners can click the `Follow` button to follow any messages, including Listeners can click the `Follow` button to follow any messages, including
episode announcements, from a Fediverse app, such as Mastodon. After clicking episode announcements, from a Fediverse app, such as Mastodon. After clicking