Skip to content

docs(author-profile): add block README#2310

Merged
rbcorrales merged 2 commits intotrunkfrom
docs/author-profile-block
Mar 10, 2026
Merged

docs(author-profile): add block README#2310
rbcorrales merged 2 commits intotrunkfrom
docs/author-profile-block

Conversation

@rbcorrales
Copy link
Member

All Submissions:

Changes proposed in this Pull Request:

Adds a developer-facing README for the Author Profile block.

Closes NPPD-1220.

How to test the changes in this Pull Request:

  1. Open src/blocks/author-profile/README.md and verify the content renders correctly on GitHub.
  2. Confirm that relative links (to templates, other blocks within the repo) resolve correctly.
  3. Confirm that absolute GitHub links (to newspack-plugin blocks) resolve correctly.

Other information:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes, as applicable?
  • Have you successfully ran tests with your changes locally?

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

Adds developer-facing documentation for the author-profile Gutenberg block, describing operating modes, rendering behavior, attributes, bindings, and editor UX.

Changes:

  • Introduces src/blocks/author-profile/README.md explaining the Author Profile block’s modes and rendering strategy.
  • Documents block attributes and block bindings keys.
  • Adds “Related” links to companion blocks/templates.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@rbcorrales
Copy link
Member Author

All flagged items reference code (variations, templates, variation attribute, variation picker UI) that exists on the feature branch in #2302. This docs PR is meant to land after that PR merges to trunk. Resolving all threads as false positives.

@rbcorrales rbcorrales marked this pull request as ready for review March 7, 2026 00:05
@rbcorrales rbcorrales requested a review from a team as a code owner March 7, 2026 00:05
Copy link
Contributor

@laurelfulford laurelfulford left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good @rbcorrales! I just flagged one line that may need to be clipped depending on how the feedback in the variation picker PR is handled, but I don't think that's a blocker since this is correct for how it works right now, and the text can be changed after the behaviour's changed :)

@rbcorrales rbcorrales merged commit e888ed8 into trunk Mar 10, 2026
11 checks passed
@rbcorrales rbcorrales deleted the docs/author-profile-block branch March 10, 2026 18:46
@github-actions
Copy link

Hey @rbcorrales, good job getting this PR merged! 🎉

Now, the needs-changelog label has been added to it.

Please check if this PR needs to be included in the "Upcoming Changes" and "Release Notes" doc. If it doesn't, simply remove the label.

If it does, please add an entry to our shared document, with screenshots and testing instructions if applicable, then remove the label.

Thank you! ❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants