Skip to content

Update/docs#108

Merged
jeffpaul merged 6 commits into
developfrom
update/docs
Nov 26, 2025
Merged

Update/docs#108
jeffpaul merged 6 commits into
developfrom
update/docs

Conversation

@jeffpaul

@jeffpaul jeffpaul commented Nov 26, 2025

Copy link
Copy Markdown
Member

What?

Closes #94.
Closes #28.

This pull request updates documentation and configuration files to clarify branch naming conventions, standardize versioning practices, and improve release management. It also adds a new screenshots section to the plugin's readme for better user guidance.

Documentation and Release Process Improvements:

  • Updated all references to the main development branch from trunk to develop, and clarified that trunk is now the stable release branch in CONTRIBUTING.md.
  • Added detailed release instructions to CONTRIBUTING.md, including a checklist for creating and publishing new releases.
  • Standardized PHPDoc @since tags to use x.x.x as a placeholder for new code, with instructions to update before release, in both documentation and code examples. [1] [2]

Workflow Configuration:

  • Updated the GitHub Actions test workflow to trigger on pushes to the new develop branch as well as trunk.

User Guidance:

  • Added a new "Screenshots" section to readme.txt to visually demonstrate key plugin features and UI elements.

Why?

How?

Testing Instructions

Testing Instructions for Keyboard

Screenshots or screencast

Before After

Test using WordPress Playground

The changes in this pull request can be previewed and tested using this WordPress Playground instance:

Click here to test this pull request.

@jeffpaul jeffpaul added this to the 0.2.0 milestone Nov 26, 2025
@jeffpaul jeffpaul requested a review from dkotter November 26, 2025 23:13
@jeffpaul jeffpaul self-assigned this Nov 26, 2025
@github-actions

github-actions Bot commented Nov 26, 2025

Copy link
Copy Markdown

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: jeffpaul <jeffpaul@git.wordpress.org>
Co-authored-by: dkotter <dkotter@git.wordpress.org>
Co-authored-by: karmatosed <karmatosed@git.wordpress.org>
Co-authored-by: anandrajaram21 <altf4falt@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@jeffpaul jeffpaul merged commit a3d5c63 into develop Nov 26, 2025
19 checks passed
@jeffpaul jeffpaul deleted the update/docs branch November 26, 2025 23:36
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.

Minimum version in plugin mismatch with documentation Plugin submission to WordPress.org

2 participants