Skip to content

docs(readme): add Screenshots section to wp.org readme draft - #152

Merged
jackgranatowski merged 1 commit into
mainfrom
claude/copy-wip-marketing-drafts
Jul 3, 2026
Merged

jackgranatowski merged 1 commit into
mainfrom
claude/copy-wip-marketing-drafts

Conversation

@jackgranatowski

@jackgranatowski jackgranatowski commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Summary

Originally split the full copy-wip/ marketing drafts out of #147. While this PR was open, #150 ("marketing-copy-review") merged its own version of copy-wip/ into main — so this PR's github-readme.md, facebook-post-bricks-community.md, and base wordpress-org-readme.txt content became redundant/conflicting with what's already shipped.

Rebuilt on top of current main: this PR now contains only the one thing main's draft is still missing — the == Screenshots == section for copy-wip/wordpress-org-readme.txt, covering the configurator (Design Settings, frontend overlay, standalone app) and Bricks-specific features (Color System panel, reBEMer, class/variable hints).

Type

  • docs

Notes

The actual screenshot-1.pngscreenshot-6.png assets still need to be captured from a live WordPress + Bricks Builder install and are not included — Bricks is a paid third-party plugin not available in this environment.

This is a draft-only change — no live-shipped file is touched.

Summary by CodeRabbit

  • Documentation
    • Added a new Screenshots section to the plugin readme.
    • Included six numbered screenshots covering the main editor, live overlay, standalone app, builder panels, and class/variable hints.
    • Moved the screenshots section to appear before the installation instructions.

@coderabbitai

coderabbitai Bot commented Jul 3, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Added a new "Screenshots" section to the WordPress plugin readme, listing six numbered screenshot descriptions covering the design settings editor, live overlay, configurator web app, and three Bricks Builder features, placed before the Installation section.

Changes

Readme Screenshots Documentation

Layer / File(s) Summary
Add Screenshots section
copy-wip/wordpress-org-readme.txt
New "Screenshots" section added with six numbered screenshot descriptions covering the design editor, live overlay, configurator, and Bricks Builder features.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: adding a Screenshots section to the WordPress.org readme draft.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/copy-wip-marketing-drafts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@qodo-code-review

Copy link
Copy Markdown

PR Summary by Qodo

Add draft marketing copy to copy-wip for review

📝 Documentation 🕐 20-40 Minutes

Grey Divider

AI Description

• Add draft GitHub README, WordPress.org readme, and Bricks community post copy.
• Keep drafts isolated in copy-wip/ without touching live-shipped README files.
• Include wp.org screenshot captions/slots to be paired with assets captured later.
Diagram

graph TD
  A["copy-wip/ drafts"] --> B["github-readme.md"] --> C[["GitHub listing"]]
  A --> D["wordpress-org-readme.txt"] --> E[["WordPress.org listing"]]
  A --> F["facebook-post-bricks-community.md"] --> G[["Bricks FB group"]]
  A --> H["Reviewer feedback"]
Loading
High-Level Assessment

The following are alternative approaches to this PR:

1. Draft directly in live docs with explicit DRAFT markers
  • ➕ Single source of truth (no later copy-paste/promotion step)
  • ➕ Review happens in the exact files that will ship
  • ➖ Risks accidentally shipping draft copy (especially in release automation)
  • ➖ Makes live README/readme.txt noisier during iteration
2. Keep drafts outside the repo (Google Doc/Notion) until final
  • ➕ Better inline commenting workflow for non-dev reviewers
  • ➕ Avoids large draft text churn in git history
  • ➖ Copy diverges from repo reality (links/paths/feature names can drift)
  • ➖ Harder to review alongside actual product structure

Recommendation: The current approach (staging in copy-wip/ and explicitly not touching shipped README/readme.txt) is the safest way to gather feedback without publication risk. If copy-wip/ becomes a long-lived pattern, consider adding a short index/README in copy-wip/ documenting promotion steps (including where wp.org screenshot assets must be added) to reduce future process ambiguity.

Files changed (3) +370 / -0

Documentation (3) +370 / -0
facebook-post-bricks-community.mdAdd Bricks community Facebook post draft +17/-0

Add Bricks community Facebook post draft

• Introduces a draft social post positioning SLASHED + the Bricks integration, including feature highlights, browser floor warning, and links to framework/plugin/configurator.

copy-wip/facebook-post-bricks-community.md

github-readme.mdAdd draft GitHub README marketing copy +90/-0

Add draft GitHub README marketing copy

• Adds a draft README describing the plugin’s value prop and major feature areas (Design Settings, Bricks integration, Gutenberg integration). Includes install/development notes and links into existing docs.

copy-wip/github-readme.md

wordpress-org-readme.txtAdd draft WordPress.org plugin readme with screenshot captions +263/-0

Add draft WordPress.org plugin readme with screenshot captions

• Adds a full wp.org readme draft: description, feature breakdowns (Design Settings/Bricks/Gutenberg), external services disclosure, browser support, installation, FAQ, and changelog. Includes a prepared 'Screenshots' section with captions for six screenshots (assets to be captured and uploaded separately).

copy-wip/wordpress-org-readme.txt

@qodo-code-review

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Qodo Logo

The copy-wip/wordpress-org-readme.txt draft merged via #150 had no
== Screenshots == section. Add one covering the configurator (Design
Settings, frontend overlay, standalone app) and the Bricks-specific
features called out for the listing: the Color System panel, reBEMer,
and class/variable hints.

The actual screenshot-N.png assets still need to be captured from a
live WordPress + Bricks install and are not included here.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@jackgranatowski
jackgranatowski force-pushed the claude/copy-wip-marketing-drafts branch from 780722e to 9dc7ea0 Compare July 3, 2026 12:09
@jackgranatowski jackgranatowski changed the title docs: add marketing copy drafts to copy-wip for review docs(readme): add Screenshots section to wp.org readme draft Jul 3, 2026

Copy link
Copy Markdown
Contributor Author

Rebased and force-pushed: main gained its own copy-wip/ drafts via #150 while this was open, which conflicted with (and made redundant) everything here except the Screenshots section. This branch now contains just that one addition on top of current main. Title/description updated to match.


Generated by Claude Code

@jackgranatowski
jackgranatowski merged commit 331c7ab into main Jul 3, 2026
9 checks passed
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.

2 participants