Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 27, 2025

Update name in documentation to "Static Site Exporter"

Completed:

  • Explore repository and identify all documentation files with old name references
  • Update docs/README.md: Change title and references from "WordPress to Jekyll Exporter" to "Static Site Exporter"
  • Update docs/CONTRIBUTING.md: Change all references from "WordPress To Jekyll Exporter" and "WordPress to Jekyll Export" to "Static Site Exporter"
  • Update docs/required-php-version.md: Change "WordPress to Jekyll Export" to "Static Site Exporter"
  • Update docs/performance-optimizations.md: Change "WordPress to Jekyll Exporter" to "Static Site Exporter"
  • Update PERFORMANCE_IMPROVEMENTS.md: Change "WordPress to Jekyll Exporter" to "Static Site Exporter"
  • Update .github/copilot-instructions.md: Change title to "Static Site Exporter"
  • Update .devcontainer/README.md: Change reference to "Static Site Exporter"
  • Update docs/examples/optimization-examples.php: Change test output to "Static Site Exporter"
  • Fix script/build-readme to skip directories when processing docs
  • Run build script to regenerate readme.txt from documentation source files
  • Verify all changes are consistent and complete
  • Merge master branch and resolve conflicts (kept "Static Site Exporter" naming in conflict resolution)
Original prompt

This section details on the original issue you should resolve

<issue_title>Update name in documentation</issue_title>
<issue_description>to Static Site Exporter</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI changed the title [WIP] Update name in documentation to Static Site Exporter Update documentation to use "Static Site Exporter" name Dec 27, 2025
Copilot AI requested a review from benbalter December 27, 2025 18:57
@benbalter benbalter marked this pull request as ready for review December 28, 2025 16:03
@benbalter benbalter requested review from Copilot and removed request for benbalter December 28, 2025 23:43
@benbalter
Copy link
Owner

@copilot merge in main and resolve any conflicts.

Copy link

Copilot AI left a 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-readme to skip directories when processing docs (preventing failures on docs/examples/)
  • Regenerates readme.txt from 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 ===
Copy link

Copilot AI Dec 28, 2025

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.

Suggested change
=== Add to crontab to run at 3 AM ===
# Add to crontab to run at 3 AM

Copilot uses AI. Check for mistakes.

= Option 2: Manual Setup =

= # Prerequisites =
Copy link

Copilot AI Dec 28, 2025

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.

Copilot uses AI. Check for mistakes.
1. `sudo pear install PHP_CodeSniffer`

= Bootstrap & Setup =
= # Bootstrap & Setup =
Copy link

Copilot AI Dec 28, 2025

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.

Copilot uses AI. Check for mistakes.
Copilot AI requested a review from benbalter as a code owner December 28, 2025 23:51
Copy link
Contributor Author

Copilot AI commented Dec 28, 2025

@copilot merge in main and resolve any conflicts.

Merged master branch successfully. The merge included WordPress 6.9 compatibility updates and deprecated function fixes. Resolved one conflict in readme.txt, keeping the "Static Site Exporter" naming consistent. Commit: 8f23580

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.

Update name in documentation

2 participants