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.

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

Update usage documentation for Annotations API #16233

Merged
merged 3 commits into from
Jun 20, 2019

Conversation

mattheu
Copy link
Contributor

@mattheu mattheu commented Jun 20, 2019

Description

Despite this being experimental, it would be great to provide some basic usage instructions for the annotations API.

Updated the annotations documentation to describe the richTextIdentifier property in more detail.

@mattheu
Copy link
Contributor Author

mattheu commented Jun 20, 2019

Actually it could just link to this page: Alternatively it could just link to this page: https://developer.wordpress.org/block-editor/developers/block-api/block-annotations/#api

@mattheu mattheu changed the title Add basic usage documentation for annotations API Update usage documentation for annotations API Jun 20, 2019
@mattheu mattheu changed the title Update usage documentation for annotations API Update usage documentation for Annotations API Jun 20, 2019
Copy link
Member

@atimmer atimmer left a comment

Choose a reason for hiding this comment

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

Great addition!

@atimmer atimmer merged commit 03473a9 into WordPress:master Jun 20, 2019
@github-actions github-actions bot added this to the Gutenberg 6.0 milestone Jun 20, 2019
## Usage

<br/><br/><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p>
Copy link
Contributor

Choose a reason for hiding this comment

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

Any reason for the "code is poetry" image removal? I think it's used in all the package readmes.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I’ll open a new PR to re-add this wasn’t intentional!

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks :)

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.

3 participants