-
-
Notifications
You must be signed in to change notification settings - Fork 129
Update documentation to use "Static Site Exporter" name #359
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
Co-authored-by: benbalter <[email protected]>
|
@copilot merge in |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR standardizes the plugin name across all documentation to "Static Site Exporter" (matching the plugin header), replacing inconsistent variations like "WordPress to Jekyll Exporter", "WordPress To Jekyll Exporter", and "WordPress to Jekyll Export".
Key changes:
- Updates plugin name to "Static Site Exporter" in 8 documentation and configuration files
- Fixes
script/build-readmeto skip directories when processing docs (preventing failures ondocs/examples/) - Regenerates
readme.txtfrom updated source documentation files
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
script/build-readme |
Adds directory check to prevent processing docs/examples/ subdirectory |
docs/README.md |
Updates title and alt text from "WordPress to Jekyll Exporter" to "Static Site Exporter" |
docs/CONTRIBUTING.md |
Updates all references from "WordPress To Jekyll Exporter" to "Static Site Exporter" |
docs/required-php-version.md |
Updates plugin name from "WordPress to Jekyll Export" to "Static Site Exporter" |
docs/performance-optimizations.md |
Updates plugin name from "WordPress to Jekyll Exporter" to "Static Site Exporter" |
docs/examples/optimization-examples.php |
Updates test output header from "WordPress to Jekyll Exporter" to "Static Site Exporter" |
.github/copilot-instructions.md |
Updates document title from "WordPress to Jekyll Exporter" to "Static Site Exporter" |
.devcontainer/README.md |
Updates plugin description from "WordPress to Jekyll Exporter" to "Static Site Exporter" |
PERFORMANCE_IMPROVEMENTS.md |
Updates plugin name from "WordPress to Jekyll Exporter" to "Static Site Exporter" |
readme.txt |
Regenerated output reflecting all documentation updates plus new dev container and performance sections |
| Schedule the export using WP-CLI and cron during low-traffic periods: | ||
|
|
||
| ```bash | ||
| === Add to crontab to run at 3 AM === |
Copilot
AI
Dec 28, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line contains invalid syntax for a bash comment in a code block. The line === Add to crontab to run at 3 AM === appears to be a result of the build-readme script incorrectly converting a markdown comment that started with #. In bash code blocks, comments should start with #, not ===. The source markdown (docs/performance-tips.md line 78) correctly has # Add to crontab to run at 3 AM, but the build script is converting it because it matches the # heading pattern. This creates invalid bash syntax in the generated readme.txt.
| === Add to crontab to run at 3 AM === | |
| # Add to crontab to run at 3 AM |
|
|
||
| = Option 2: Manual Setup = | ||
|
|
||
| = # Prerequisites = |
Copilot
AI
Dec 28, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The heading format = # Prerequisites = is invalid for WordPress readme.txt files. This occurs because the source markdown in docs/developing-locally.md uses #### heading level, which is not properly handled by the build-readme script's conversion logic. The script converts ### to =, ## to ==, and # to ===, but when it encounters ####, it converts the first three ### to = and leaves the fourth # behind, resulting in = # Prerequisites =.
To fix this, the source markdown file should use ### (not ####) for these subsection headings, which will properly convert to single = format in readme.txt.
| 1. `sudo pear install PHP_CodeSniffer` | ||
|
|
||
| = Bootstrap & Setup = | ||
| = # Bootstrap & Setup = |
Copilot
AI
Dec 28, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The heading format = # Bootstrap & Setup = is invalid for WordPress readme.txt files. This occurs because the source markdown in docs/developing-locally.md uses #### heading level, which is not properly handled by the build-readme script. The source should use ### heading level instead to properly convert to single = format.
Co-authored-by: benbalter <[email protected]>
Update name in documentation to "Static Site Exporter"
Completed:
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.