Skip to content

add patchstack to faq in readmes#350

Merged
jeffpaul merged 2 commits into
developfrom
add/patchstack-faq
Jan 13, 2026
Merged

add patchstack to faq in readmes#350
jeffpaul merged 2 commits into
developfrom
add/patchstack-faq

Conversation

@jeffpaul

@jeffpaul jeffpaul commented Jan 13, 2026

Copy link
Copy Markdown
Member

Description of the Change

This pull request updates the documentation for the Simple Podcasting plugin, focusing on improving organization, clarity, and accessibility of key information for users. The most notable changes include restructuring the readme.txt and README.md files, moving frequently asked questions (FAQ) into a dedicated section, and adding instructions for reporting security bugs.

Documentation restructuring and clarity:

  • Reorganized readme.txt to use more consistent section headings (e.g., = Create your podcast =) and improved the step-by-step instructions for installation and usage. [1] [2]
  • Moved FAQ content (“How do I get my podcast featured on Pocket Casts?”, “How do I submit private and paid podcast feeds?”) into a dedicated “Frequently Asked Questions” section in both readme.txt and README.md for better visibility and easier access. [1] [2] [3]

Security and support information:

  • Added instructions on how to report security bugs via the Patchstack Vulnerability Disclosure Program to both documentation files. [1] [2]
  • Clarified support level and technical requirements, such as PHP version and RSS feed prerequisites, in the documentation. [1] [2]

Minor formatting and consistency fixes:

  • Standardized section headings throughout readme.txt for easier navigation and improved readability. [1] [2]
  • Removed duplicate and outdated FAQ content from the main body and consolidated it under the new FAQ section. [1] [2]

How to test the Change

Changelog Entry

Developer - Add Patchstack security-reporting FAQ.

Credits

Props @jeffpaul.

Checklist:

Updated formatting and organization of the readme file, including section headings and content adjustments for clarity.
@jeffpaul jeffpaul added this to the 2.0.0 milestone Jan 13, 2026
@jeffpaul jeffpaul self-assigned this Jan 13, 2026
Reorganize FAQ section and restore previously removed content.
@jeffpaul jeffpaul marked this pull request as ready for review January 13, 2026 21:00
@jeffpaul jeffpaul requested a review from a team as a code owner January 13, 2026 21:00
@jeffpaul jeffpaul requested review from peterwilsoncc and removed request for a team January 13, 2026 21:00
@jeffpaul jeffpaul merged commit be3fc4c into develop Jan 13, 2026
12 checks passed
@jeffpaul jeffpaul deleted the add/patchstack-faq branch January 13, 2026 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant