Skip to content

Docs: Update Interactivity API package readme#59763

Merged
ndiego merged 3 commits intotrunkfrom
docs/update-iapi-docs
Mar 11, 2024
Merged

Docs: Update Interactivity API package readme#59763
ndiego merged 3 commits intotrunkfrom
docs/update-iapi-docs

Conversation

@ndiego
Copy link
Member

@ndiego ndiego commented Mar 11, 2024

This PR updates the Interactivity API package readme with additional information provided in the WordPress 6.5 Dev Note and cleans up some outdated information. I also fixed the callout on the API Reference page.

More work is needed on this readme and the Interactivity API documentation more broadly, so consider this an initial iteration.

Potential future updates:

  • The docs still mention wp-now, this should be removed in the next iteration, but wp-env support needs to be added to the @wordpress/create-block-interactive-template
  • Perhaps move the Quick Start Guide section to its own doc (The guide might not even be needed since we have the generic Quick Start Guide)
  • Add more general information about directives and the Store.
  • Move more sections from the WordPress 6.5 Dev Note into the Block Editor Handbook docs.

@ndiego ndiego added the [Type] Developer Documentation Documentation for developers label Mar 11, 2024
@ndiego ndiego requested a review from justintadlock March 11, 2024 20:37
@ndiego ndiego self-assigned this Mar 11, 2024
@ndiego ndiego requested a review from ryanwelcher March 11, 2024 20:37
@github-actions
Copy link

github-actions bot commented Mar 11, 2024

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: ndiego <ndiego@git.wordpress.org>
Co-authored-by: justintadlock <greenshady@git.wordpress.org>

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

Copy link
Contributor

@justintadlock justintadlock left a comment

Choose a reason for hiding this comment

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

Nice update!

@ndiego ndiego enabled auto-merge (squash) March 11, 2024 20:54
@ndiego ndiego merged commit 605cce2 into trunk Mar 11, 2024
@ndiego ndiego deleted the docs/update-iapi-docs branch March 11, 2024 21:11
@github-actions github-actions bot added this to the Gutenberg 18.0 milestone Mar 11, 2024
carstingaxion pushed a commit to carstingaxion/gutenberg that referenced this pull request Mar 27, 2024
* Change callout to an alert.
* Update intro, remove TOC, and change headings
* Update Installation and Quick Start Guide sections.

Co-authored-by: ndiego <ndiego@git.wordpress.org>
Co-authored-by: justintadlock <greenshady@git.wordpress.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Type] Developer Documentation Documentation for developers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants