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

Docs: Update Format API how to guide #37298

Merged
merged 4 commits into from
Dec 13, 2021
Merged

Docs: Update Format API how to guide #37298

merged 4 commits into from
Dec 13, 2021

Conversation

mkaz
Copy link
Member

@mkaz mkaz commented Dec 10, 2021

Description

Closes #36695

Update the Format API to a single page how to guide, following the new how to guide template, and adding links to the prerequisites such as plugin and JavaScript information. The goal is to focus on the format API and leave teaching more about plugins and JavaScript to other tutorials.

  • Removes ES5 examples in favor of single JSX
  • Update screenshots for new toolbar (WP 5.9)
  • Added build instructions and troubleshooting
  • Move links to references to the bottom to avoid link distractions

How has this been tested?

Documentation changes. Check for:

  • Clarity: content makes sense and accurate,
  • Mistakes: check for typos or spelling issues,
  • Complete: Anything missing or questions unanswered?

Types of changes

Documentation. Condenses the previous multi-part format API tutorial down to a single page.

Closes #36695

Update the Format API to a single page how to guide, following the new
how to guide template, and adding links to the prerequisites such as plugin and
JavaScript information.

- Removes ES5 examples in favor of single JSX
- Update screenshots for new toolbar (WP 5.9)
- Added build instructions and troubleshooting
@mkaz mkaz requested a review from ajitbohra as a code owner December 10, 2021 19:50
@mkaz mkaz added the [Type] Developer Documentation Documentation for developers label Dec 10, 2021
Copy link
Contributor

@ryanwelcher ryanwelcher 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. Just one suggestion and a question about using destructuring - not blockers though

docs/how-to-guides/format-api.md Outdated Show resolved Hide resolved
docs/how-to-guides/format-api.md Outdated Show resolved Hide resolved
Copy link
Contributor

@ryanwelcher ryanwelcher left a comment

Choose a reason for hiding this comment

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

LGTM 👍

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.

Docs: apply how to guide template to Format API guide
2 participants