Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Docs/interactivity api router package readme #62062

Merged
merged 8 commits into from
Oct 2, 2024
Merged

Docs/interactivity api router package readme #62062

merged 8 commits into from
Oct 2, 2024

Conversation

juanmaguitar
Copy link
Contributor

What?

It updates the README of the @wordpress/interactivity-router package

Why?

Because the package @wordpress/interactivity-router has had changes that are not properly reflected in the README
This PR solves #62055

@juanmaguitar juanmaguitar marked this pull request as ready for review September 30, 2024 08:23
@github-actions GitHub Actions
Copy link

github-actions bot commented Sep 30, 2024 •
edited
Loading

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: juanmaguitar <[email protected]>
Co-authored-by: michalczaplinski <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@github-actions GitHub Actions
Copy link

Flaky tests detected in 134105b.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/11102541829
📝 Reported issues:

@juanmaguitar juanmaguitar added [Feature] Interactivity API API to add frontend interactivity to blocks. [Package] Interactivity Router /packages/interactivity-router [Type] Developer Documentation Documentation for developers labels Oct 1, 2024
michalczaplinski
michalczaplinski approved these changes Oct 2, 2024
View reviewed changes
Copy link
Contributor

@michalczaplinski michalczaplinski left a comment

Choose a reason for hiding this comment

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

Thank you @juanmaguitar! This improves the docs significantly!!

I've added some additional clarifications and minor improvements.

I'm happy to approve and merge already but cc @DAreRodz if you would like to add anything

@michalczaplinski michalczaplinski enabled auto-merge (squash) October 2, 2024 13:33
@michalczaplinski
Copy link
Contributor

I would love to have more expansive use-case-based documentation on client-side navigation (both full-page and region-based) in the near future.

Hotwired Turbo has almost the same concepts:

  • Turbo Drive ---> full-page navigation
  • Turbo Frames ---> region-based navigation

Their docs do a great job explaining the differences and use cases for each of them.

@michalczaplinski michalczaplinski merged commit df0acb0 into trunk Oct 2, 2024
63 checks passed
@michalczaplinski michalczaplinski deleted the docs/interactivity-api-router-package-readme branch October 2, 2024 13:48
@github-actions github-actions bot added this to the Gutenberg 19.4 milestone Oct 2, 2024
huubl pushed a commit to huubl/gutenberg that referenced this pull request Oct 2, 2024
@juanmaguitar @michalczaplinski @huubl
Docs/interactivity api router package readme (WordPress#62062)
f4e78a2 
* Updated intro to the package

* removed examples and demos

* update README.md

* Query Loop reference

* fixed typo

* Wording improved

* Interactivity API: Update and expand on the interactivity-router docs

* Update the inline HTML in the callout

---------

Co-authored-by: Michal Czaplinski <[email protected]>
huubl added a commit to huubl/gutenberg that referenced this pull request Oct 2, 2024
@huubl
Revert "Docs/interactivity api router package readme (WordPress#62062)"
742f05d 
This reverts commit f4e78a2.
draganescu pushed a commit that referenced this pull request Oct 2, 2024
@juanmaguitar @michalczaplinski @draganescu
Docs/interactivity api router package readme (#62062)
78c0be8 
* Updated intro to the package

* removed examples and demos

* update README.md

* Query Loop reference

* fixed typo

* Wording improved

* Interactivity API: Update and expand on the interactivity-router docs

* Update the inline HTML in the callout

---------

Co-authored-by: Michal Czaplinski <[email protected]>
@draganescu draganescu mentioned this pull request Oct 2, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@michalczaplinski michalczaplinski michalczaplinski approved these changes

@DAreRodz DAreRodz Awaiting requested review from DAreRodz

Assignees
No one assigned
Labels
[Feature] Interactivity API API to add frontend interactivity to blocks. [Package] Interactivity Router /packages/interactivity-router [Type] Developer Documentation Documentation for developers
Projects
None yet
Milestone
Gutenberg 19.4
Development

Successfully merging this pull request may close these issues.
2 participants
@juanmaguitar @michalczaplinski