From 4c46c15e39b2484f6035aa38c672bd2e903487c1 Mon Sep 17 00:00:00 2001 From: Paul Cutler Date: Mon, 13 Oct 2025 05:48:47 -0500 Subject: [PATCH 01/19] docs: update docs to expand Persons information and fix broken chapters.json link --- .../content/docs/en/user-guide/instance/persons.mdx | 6 +++++- .../content/docs/en/user-guide/podcast/episodes.mdx | 11 +++++++---- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/docs/src/content/docs/en/user-guide/instance/persons.mdx b/docs/src/content/docs/en/user-guide/instance/persons.mdx index abe0d80c..df466786 100644 --- a/docs/src/content/docs/en/user-guide/instance/persons.mdx +++ b/docs/src/content/docs/en/user-guide/instance/persons.mdx @@ -4,7 +4,11 @@ title: Manage Podcast contributors The **Persons** section allows you to add podcast contributors. It is needed in the Podcast section to assign roles and is also used on the **Credits** page -linked from your podcast's homepage. +linked from your podcast's homepage. When Persons are assigned to a specific +episode, there will be a link on the episode's page to list all persons assigned. + +A Person must be created in the **Persons** section before it can be [assigned +to an episode](../podcast/episodes#persons). From the left hand navigation, press `Persons` to expand the menu. To view a list of all people that have been added to Castopod, press `All Persons`. diff --git a/docs/src/content/docs/en/user-guide/podcast/episodes.mdx b/docs/src/content/docs/en/user-guide/podcast/episodes.mdx index 75dde451..5618538a 100644 --- a/docs/src/content/docs/en/user-guide/podcast/episodes.mdx +++ b/docs/src/content/docs/en/user-guide/podcast/episodes.mdx @@ -31,8 +31,11 @@ episode. ### Persons -If you have added people in the Admin interface, you can choose a person and -assign them a role, such as guest, for a given episode. +If you have added [people in the Admin interface](../instance/persons), you can +choose a person and assign them a role, such as guest, for a given episode. When +persons are assigned to an episode, a link will be displayed on the episode page +listing the person's name and role and they will be listed in the Credits page. +Adding persons to an episode page is optional. ### Video clips and Soundbites @@ -116,7 +119,7 @@ will be displayed. You can add a transcript to your episode by choosing a file in SRT or VTT format to upload. Transcripts will be shown in a tab on the episode page and some -podcast apps such as Apple Podcasts can display the transcript. +podcast apps such as Apple Podcasts can display the transcript. Transcripts help users who may have a hearing disability and can also help with search engine optimization. @@ -124,7 +127,7 @@ search engine optimization. You can optionally upload a chapters file in JSON format. To learn more about chapters and for an example of the correct format, visit the -[Podcast Namespace](https://github.com/Podcastindex-org/podcast-namespace/blob/main/chapters/jsonChapters.md). +[Podcast Namespace](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/examples/chapters/example.json).