Repository navigation
docs: refresh the README - #4
Merged
Merged
Conversation
…cts their own README GitHub shows .github/README.md before the root one, and the scaffolder's File::allFiles() skips dot-directories, so the showcase stays on GitHub and the root README, with placeholders, becomes the generated project's guide.
The rsync now leaves README.md, .github/ and the license files alone (with --delete it removed .github/ and its workflows), the sed loop and leak check skip .github/ and bin/ (they rewrote the template's own tests), and the package.json license is set back after the sync.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two READMEs.
.github/README.mdis the GitHub showcase (GitHub shows it before the root one). The scaffolder copies withFile::allFiles(), which skips dot-directories (checked), so it never reaches users. The rootREADME.mdis the generated project's own guide: placeholders thatmake:theme/make:pluginfill in (checked againstbin/replacements.php: no placeholder left), what's inside, the commands, links to pollora.dev. No banner, no org footer.Packaging. The rsync now leaves
/README.md,/.github/,/LICENSEand/license.txtalone. Before this,--deletewould have removed.github/and its workflows, because the dev copies have none. Thepackage.jsonlicense is set back after the sync, and the sed loop and leak check skip.github/.Showcase (
.github/README.md): banner, version and license badges, screenshot.pollora:make:themereplaces the dashed name (6 times). Requirements: PHP 8.4+, WordPress 7.1+, Node 20.19+/22.12+ (Vite 8). Design-token and design-system sections kept. Placeholders table fixed: it showed the dev values. Docs links, Contributing and License footer.Also: LICENSE holder line links rubee.group.
package.jsondeclares MIT (package-theme.shputs it back after the sync). The sed loop and leak check skipbin/: until now packaging rewrotebin/tests/contract.phpand then failed its own leak check.Checked:
php bin/tests/run.phppasses 26/26. A packaging run from the localpollora-startercopy succeeds and leaves README, .github, LICENSE and bin untouched. No tag.