Update .wordpress-org README.md to reflect new asset organization
Some checks failed
ci/woodpecker/push/woodpecker Pipeline is pending
Plugin Asset Update / Push assets to WordPress.org (push) Has been cancelled
Build Release / Build and Create Release (push) Has been cancelled
Build Release / Deploy to WordPress.org (push) Has been cancelled
ci/woodpecker/tag/woodpecker Pipeline was successful
Some checks failed
ci/woodpecker/push/woodpecker Pipeline is pending
Plugin Asset Update / Push assets to WordPress.org (push) Has been cancelled
Build Release / Build and Create Release (push) Has been cancelled
Build Release / Deploy to WordPress.org (push) Has been cancelled
ci/woodpecker/tag/woodpecker Pipeline was successful
This commit is contained in:
@ -5,21 +5,42 @@ This directory contains assets specific to the WordPress.org plugin repository a
|
|||||||
## Directory Structure
|
## Directory Structure
|
||||||
|
|
||||||
```
|
```
|
||||||
/assets/
|
/.wordpress-org/
|
||||||
icon-256x256.png
|
/assets/
|
||||||
icon-128x128.png
|
icon-256x256.png
|
||||||
banner-772x250.png
|
icon-128x128.png
|
||||||
banner-1544x500.png
|
banner-772x250.png
|
||||||
screenshot-1.png
|
banner-1544x500.png
|
||||||
|
screenshot-1.png
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Asset Organization
|
||||||
|
|
||||||
|
- **PNG Files**: All PNG files for WordPress.org are stored in this directory (`.wordpress-org/assets/`)
|
||||||
|
- **Source Files**: Source files (PXD, SVG) are stored in the main `assets/` directory:
|
||||||
|
- `assets/banner/banner-1544x500.pxd`
|
||||||
|
- `assets/icon/icon.svg`
|
||||||
|
- `assets/icon/icon-1024x1024.pxd`
|
||||||
|
- `assets/screenshots/screenshot-1.pxd`
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
|
|
||||||
When using GitHub Actions for WordPress.org plugin deployments (via the 10up WordPress GitHub Actions), this directory is used to automatically update plugin assets in the WordPress.org repository.
|
When using GitHub Actions for WordPress.org plugin deployments (via the 10up WordPress GitHub Actions), this directory is used to automatically update plugin assets in the WordPress.org repository.
|
||||||
|
|
||||||
## Naming Conventions
|
## Naming Conventions
|
||||||
|
|
||||||
Files must be named exactly as shown above to be properly recognized by the WordPress.org system during the deployment process.
|
Files must be named exactly as shown above to be properly recognized by the WordPress.org system during the deployment process:
|
||||||
|
|
||||||
|
### Banner Images
|
||||||
|
- `banner-772x250.png` - 772x250 pixel PNG banner (required for WordPress.org)
|
||||||
|
- `banner-1544x500.png` - 1544x500 pixel PNG banner for high-DPI displays (optional for WordPress.org)
|
||||||
|
|
||||||
|
### Icon Images
|
||||||
|
- `icon-256x256.png` - 256x256 pixel PNG icon (required for WordPress.org)
|
||||||
|
- `icon-128x128.png` - 128x128 pixel PNG icon (optional for WordPress.org)
|
||||||
|
|
||||||
|
### Screenshots
|
||||||
|
- `screenshot-1.png` - Main screenshot showing the plugin in action
|
||||||
|
|
||||||
## Right-to-Left (RTL) Support
|
## Right-to-Left (RTL) Support
|
||||||
|
|
||||||
@ -31,9 +52,17 @@ For plugins that support Right-to-Left languages (like Hebrew and Arabic), you c
|
|||||||
|
|
||||||
Note that the `-rtl` suffix is specifically for Right-to-Left language support, not for dark mode versions of assets.
|
Note that the `-rtl` suffix is specifically for Right-to-Left language support, not for dark mode versions of assets.
|
||||||
|
|
||||||
|
## Build Process
|
||||||
|
|
||||||
|
The build script (`build.sh`) is configured to:
|
||||||
|
1. Keep source files (PXD, SVG) in the `assets/` directory for development
|
||||||
|
2. Use PNG files from the `.wordpress-org/assets/` directory for the build
|
||||||
|
3. Copy these PNG files to the appropriate locations in the build directory
|
||||||
|
|
||||||
## Additional Resources
|
## Additional Resources
|
||||||
|
|
||||||
For more detailed information about WordPress.org plugin assets, please see:
|
For more detailed information about WordPress.org plugin assets, please see:
|
||||||
|
|
||||||
- [WordPress Plugin Developer Handbook - Plugin Assets](https://developer.wordpress.org/plugins/wordpress-org/plugin-assets/)
|
- [WordPress Plugin Developer Handbook - Plugin Assets](https://developer.wordpress.org/plugins/wordpress-org/plugin-assets/)
|
||||||
- [WordPress Plugin Directory README.txt Standard](https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/)
|
- [WordPress Plugin Directory README.txt Standard](https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/)
|
||||||
|
- [WordPress.org Plugin Submission Assets Guide](../assets/WORDPRESS_ORG_ASSETS.md)
|
Before Width: | Height: | Size: 30 KiB After Width: | Height: | Size: 30 KiB |
@ -1,18 +0,0 @@
|
|||||||
# WordPress.org Banner Files
|
|
||||||
|
|
||||||
This directory contains source files for banners. The actual PNG files used for the WordPress.org plugin repository are stored in the `.wordpress-org/assets/` directory.
|
|
||||||
|
|
||||||
## Files in this Directory
|
|
||||||
|
|
||||||
- `banner-1544x500.pxd` - Source file for editing in Pixelmator
|
|
||||||
|
|
||||||
## Files in .wordpress-org/assets/
|
|
||||||
|
|
||||||
- `banner-772x250.png` - 772x250 pixel PNG banner (required for WordPress.org)
|
|
||||||
- `banner-1544x500.png` - 1544x500 pixel PNG banner for high-DPI displays (optional for WordPress.org)
|
|
||||||
|
|
||||||
## WordPress.org Submission
|
|
||||||
|
|
||||||
For detailed information about WordPress.org banner requirements and submission process, please see the main asset documentation:
|
|
||||||
|
|
||||||
[WordPress.org Plugin Submission Assets Guide](../WORDPRESS_ORG_ASSETS.md)
|
|
@ -1,19 +0,0 @@
|
|||||||
# WordPress.org Icon Files
|
|
||||||
|
|
||||||
This directory contains source files for icons. The actual PNG files used for the WordPress.org plugin repository are stored in the `.wordpress-org/assets/` directory.
|
|
||||||
|
|
||||||
## Files in this Directory
|
|
||||||
|
|
||||||
- `icon.svg` - Source SVG icon
|
|
||||||
- `icon-1024x1024.pxd` - Source file for editing in Pixelmator
|
|
||||||
|
|
||||||
## Files in .wordpress-org/assets/
|
|
||||||
|
|
||||||
- `icon-256x256.png` - 256x256 pixel PNG icon (required for WordPress.org)
|
|
||||||
- `icon-128x128.png` - 128x128 pixel PNG icon (optional for WordPress.org)
|
|
||||||
|
|
||||||
## WordPress.org Submission
|
|
||||||
|
|
||||||
For detailed information about WordPress.org icon requirements and submission process, please see the main asset documentation:
|
|
||||||
|
|
||||||
[WordPress.org Plugin Submission Assets Guide](../WORDPRESS_ORG_ASSETS.md)
|
|
@ -1,17 +0,0 @@
|
|||||||
# WordPress.org Screenshot Files
|
|
||||||
|
|
||||||
This directory contains source files for screenshots. The actual PNG files used for the WordPress.org plugin repository are stored in the `.wordpress-org/assets/` directory.
|
|
||||||
|
|
||||||
## Files in this Directory
|
|
||||||
|
|
||||||
- `screenshot-1.pxd` - Source file for editing in Pixelmator
|
|
||||||
|
|
||||||
## Files in .wordpress-org/assets/
|
|
||||||
|
|
||||||
- `screenshot-1.png` - Main screenshot showing the plugin in action
|
|
||||||
|
|
||||||
## WordPress.org Submission
|
|
||||||
|
|
||||||
For detailed information about WordPress.org screenshot requirements and submission process, please see the main asset documentation:
|
|
||||||
|
|
||||||
[WordPress.org Plugin Submission Assets Guide](../WORDPRESS_ORG_ASSETS.md)
|
|
Reference in New Issue
Block a user