Skip to content

Open "docs" folder for the Interactivity API package and Getting Started Guide#52462

Merged
juanmaguitar merged 13 commits intotrunkfrom
docs/interactivity-api
Jul 20, 2023
Merged

Open "docs" folder for the Interactivity API package and Getting Started Guide#52462
juanmaguitar merged 13 commits intotrunkfrom
docs/interactivity-api

Conversation

@juanmaguitar
Copy link
Copy Markdown
Contributor

@juanmaguitar juanmaguitar commented Jul 10, 2023

What?

Open the "docs" folder for the Interactivity API package with some initial content

Why?

So there's a main reference for the docs of this project

@github-actions
Copy link
Copy Markdown

github-actions bot commented Jul 10, 2023 •
edited
Loading

Flaky tests detected in 993c5df.
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/5578438394
📝 Reported issues:

luisherranz
luisherranz approved these changes Jul 17, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@luisherranz luisherranz left a comment

Choose a reason for hiding this comment

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

Looks good to me!! 🙂

I only have one comment: I see that the official guide recommends Node 14, but in my experience that's only true for Gutenberg itself, not for external plugins relying on wp-scripts. So I would not recommend having to install Node 14, which is complex because it's an outdated version. Whatever version people have should be fine. Actually, wp-now requires at least Node 16, so if we are recommending it, it would be very confusing to ask people to run wp-scripts with Node 14 and wp-now with Node 16+. Anyway, I would just say "Node".

@juanmaguitar
Copy link
Copy Markdown
Contributor Author

juanmaguitar commented Jul 17, 2023

Actually, wp-now requires at least Node 16

@luisherranz Do you have located any official resources stating this recommendation for wp-now?
I don't see any references to the recommended Node version at https://www.npmjs.com/package/@wp-now/wp-now

@luisherranz
Copy link
Copy Markdown
Member

luisherranz commented Jul 17, 2023

It looks like their minimum supported version is Node 18 as of today.

@juanmaguitar juanmaguitar mentioned this pull request Jul 17, 2023
Closed
@juanmaguitar juanmaguitar changed the title Open "docs" folder for the Interactivity API package Open "docs" folder for the Interactivity API package and Getting Started Guide Jul 17, 2023
@juanmaguitar juanmaguitar requested a review from luisherranz July 17, 2023 13:58
@juanmaguitar
Copy link
Copy Markdown
Contributor Author

juanmaguitar commented Jul 17, 2023

[...] I would not recommend having to install Node 14, which is complex because it's an outdated version. Whatever version people have should be fine.

@luisherranz As per your feedback, I have updated the docs to remove any specific recommendation for a Node version.

@juanmaguitar juanmaguitar requested review from SantosGuillamot and removed request for cbravobernal July 18, 2023 09:24
@juanmaguitar juanmaguitar mentioned this pull request Jul 19, 2023
Closed
@juanmaguitar juanmaguitar merged commit 8aa016e into trunk Jul 20, 2023
@juanmaguitar juanmaguitar deleted the docs/interactivity-api branch July 20, 2023 08:17
@github-actions github-actions bot added this to the Gutenberg 16.4 milestone Jul 20, 2023
westonruter added a commit that referenced this pull request Jul 20, 2023
@westonruter
Merge remote-tracking branch 'origin/trunk' into add/defer-script-loa…
da2380a 
…ding-strategy

* origin/trunk: (59 commits)
  Promisify action creator return type for WP data dispatch (#52530)
  [RNMobile] Add WP hook for registering non-core blocks (#52791)
  removes check for active preview device type to enable the fixed toolbar preference (#52770)
  Enforce checks against redeclaration for functions and classes (#52696)
  update appearance tools, (#52785)
  Behaviors: Extend Global Styles API to read/write behaviors config. (#52370)
  HeaderToolbar - Update inserterMethod meta data (#52735)
  add options for debugging php unit tests (#52778)
  Docs: Interactivity API > Getting Started Guide - minor adjustments (#52786)
  Footnotes: Use static closures when not using '' (#52781)
  Improve slug generation & matching in request utils (#52414)
  Open "docs" folder for the Interactivity API package and Getting Started Guide (#52462)
  Global Styles: Don't use named arguments for 'sprintf' (#52782)
  E2E utils - Update locator to hide the keyboard on iOS to pick the first element, on iPad two buttons are available and the second one makes the floating keyboard to show up (#52771)
  Patterns: Reinstate template parts mode spec (#52780)
  chore(release): publish
  Update changelog files
  Patterns: Fix empty general template parts category (#52747)
  Add id to pattern inserted notice to stop multiple notices stacking (#52746)
  Site Editor: Fix site link accessibility issues (#52744)
  ...
@luisherranz luisherranz added [Feature] Interactivity API API to add frontend interactivity to blocks. [Type] Developer Documentation Documentation for developers labels Jul 21, 2023
@luisherranz luisherranz mentioned this pull request Jul 21, 2023
Closed
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@luisherranz luisherranz luisherranz approved these changes

@DAreRodz DAreRodz Awaiting requested review from DAreRodz DAreRodz is a code owner

@SantosGuillamot SantosGuillamot Awaiting requested review from SantosGuillamot

Assignees

No one assigned

Labels

[Feature] Interactivity API API to add frontend interactivity to blocks. [Type] Developer Documentation Documentation for developers

Projects

None yet

Milestone

Gutenberg 16.4

Development

Successfully merging this pull request may close these issues.

2 participants

@juanmaguitar @luisherranz