Update ignore and export rules for project files#126
Update ignore and export rules for project files#126theaminulai merged 4 commits intodevelopmentfrom
Conversation
Refined .distignore, .gitattributes, and composer.json to consistently exclude development, configuration, and documentation files and directories from distributions and exports. This improves package cleanliness and ensures only necessary files are included in releases.
Added detailed Key Features section to both README.md and readme.txt, highlighting preloading, performance optimization, and security enhancements. Updated badge and support links to use the correct GitHub username. Improved table of contents and clarified configuration instructions.
There was a problem hiding this comment.
Pull request overview
This PR updates the public documentation for the PageFlash plugin to highlight new preloading and optimization features and adjusts several GitHub links. It refreshes the feature lists in both the WordPress.org readme and the GitHub README and tweaks FAQ wording to match the current configuration flow.
Changes:
- Rewrites the “Key Features” section in
readme.txtto describe Quicklink, InstantPage, performance optimizations, and security enhancements, and updates an FAQ entry to explain how to configure PageFlash via its settings page. - Adds a “Key Features” section to
README.mdwith the same feature breakdown as the plugin readme and updates the table of contents accordingly. - Modifies multiple GitHub-related URLs and the final thank-you/support copy in
README.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| readme.txt | Updated plugin description and FAQ text to reflect the new preloading, optimization, and security features and the current configuration flow. |
| README.md | Synced feature documentation with the plugin readme, expanded the table of contents, and changed several GitHub asset/support URLs and closing copy. |
README.md
Outdated
| <br /> | ||
| <a href="https://wordpress.org/plugins/pageflash/" target="_blank"> | ||
| <img src="https://github.com/theaminuli/pageflash/blob/development/screenshot.png" alt="PageFlash Banner"> | ||
| <img src="https://github.com/theaminulai/pageflash/blob/development/screenshot.png" alt="PageFlash Banner"> |
There was a problem hiding this comment.
The GitHub screenshot image URL now points to github.com/theaminulai/pageflash, but the canonical repository URL elsewhere in the project is github.com/theaminuli/pageflash, so this link will 404 and the banner image will not render; please align this URL with the actual repository path.
| <img src="https://github.com/theaminulai/pageflash/blob/development/screenshot.png" alt="PageFlash Banner"> | |
| <img src="https://github.com/theaminuli/pageflash/blob/development/screenshot.png" alt="PageFlash Banner"> |
| <img src="https://img.shields.io/badge/PHP-777BB4?style=for-the-badge&logo=php&logoColor=white" alt="php" /> | ||
| <img src="https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=#white" alt="Sponsors" /> | ||
| <img alt="GitHub License" src="https://img.shields.io/github/license/theaminuli/pageflash?style=for-the-badge&logo=License-GPLv3-blue" alt="License-GPLv3"> | ||
| <img alt="GitHub License" src="https://img.shields.io/github/license/theaminulai/pageflash?style=for-the-badge&logo=License-GPLv3-blue" alt="License-GPLv3"> |
There was a problem hiding this comment.
The GitHub license badge URL has the same theaminulai username typo as the screenshot URL, which will break the badge image because the repository actually lives under theaminuli/pageflash; please update the URL to reference the correct GitHub owner.
| <img alt="GitHub License" src="https://img.shields.io/github/license/theaminulai/pageflash?style=for-the-badge&logo=License-GPLv3-blue" alt="License-GPLv3"> | |
| <img alt="GitHub License" src="https://img.shields.io/github/license/theaminuli/pageflash?style=for-the-badge&logo=License-GPLv3-blue" alt="License-GPLv3"> |
| <img src="https://img.shields.io/badge/PHP-777BB4?style=for-the-badge&logo=php&logoColor=white" alt="php" /> | ||
| <img src="https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=#white" alt="Sponsors" /> | ||
| <img alt="GitHub License" src="https://img.shields.io/github/license/theaminuli/pageflash?style=for-the-badge&logo=License-GPLv3-blue" alt="License-GPLv3"> | ||
| <img alt="GitHub License" src="https://img.shields.io/github/license/theaminulai/pageflash?style=for-the-badge&logo=License-GPLv3-blue" alt="License-GPLv3"> |
There was a problem hiding this comment.
This <img> tag declares the alt attribute twice, which is invalid HTML and can cause inconsistent behavior in assistive technologies; please keep a single alt attribute with the intended descriptive text.
| <img alt="GitHub License" src="https://img.shields.io/github/license/theaminulai/pageflash?style=for-the-badge&logo=License-GPLv3-blue" alt="License-GPLv3"> | |
| <img src="https://img.shields.io/github/license/theaminulai/pageflash?style=for-the-badge&logo=License-GPLv3-blue" alt="GitHub License: GPLv3"> |
| ## <a name="support"> ☎️ Support </a> | ||
|
|
||
| If you encounter issues or have questions, please [open an issue](https://github.com/theaminuli/pageflash/issues). We're here to help! | ||
| If you encounter issues or have questions, please [open an issue](https://github.com/theaminulai/pageflash/issues). We're here to help! |
There was a problem hiding this comment.
The support link here also uses github.com/theaminulai/pageflash, which does not match the actual repository path github.com/theaminuli/pageflash used elsewhere and will lead users to a non‑existent issues page; please update the URL to the correct repository.
| If you encounter issues or have questions, please [open an issue](https://github.com/theaminulai/pageflash/issues). We're here to help! | |
| If you encounter issues or have questions, please [open an issue](https://github.com/theaminuli/pageflash/issues). We're here to help! |
|
|
||
| **PageFlash** is a powerful WordPress plugin that preloads pages intelligently to boost site speed and enhance user experience. By loading pages before users click, PageFlash ensures instant page transitions, creating a seamless and lightning-fast browsing experience for your visitors. | ||
|
|
||
| ## 🚀 Key Features |
There was a problem hiding this comment.
The PR title and changelog entry describe "Update ignore and export rules for project files", but this change only updates README copy and links; please either adjust the PR description/title or include the corresponding ignore/export rule changes so they stay in sync.
Changed the image source URL in the README banner to use the raw.githubusercontent.com domain for direct image access.
No description provided.