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: Alphabetize the How to Guides section #35904

Merged
merged 4 commits into from
Nov 19, 2021
Merged

Conversation

mkaz
Copy link
Member

@mkaz mkaz commented Oct 24, 2021

Description

To make it easier to browse and find items in the How to Guides section, this
alphabetizes the list and updates some of the document names to shorter titles
that allow for easier scaning.

Changes are:

  • Gutenberg as a Development Platform => App Platform

  • Introduction to the Format API => Formatting Toolbar

  • Displaying Notices from Your Plugin or Theme => Notices

  • Creating a Sidebar for Your Plugin => Plugin Sidebar

In a separate PR I will move the "Getting Started with JavaScript" to the Getting Started section out of the How To Guides, so that was left unchanged.

How has this been tested?

  • Confirm the table of contents organization looks correct (I used cold folding to help wrangle the JSON).
  • Confirm new titles are spelled correctly and appropriate.
  • Confirm additional text in Plugin Sidebar makes sense.

Types of changes

  • An organization change of table of contents
  • Modified titles of four pages
  • Added additional context about plugin sidebar

@mkaz mkaz added the [Type] Developer Documentation Documentation for developers label Oct 24, 2021
mkaz and others added 2 commits October 29, 2021 14:23
To make it easier to browse and find items in the How to Guides section,
this alphabetizes the list and updates some of the document names to
shorter titles that allow for easier scaning.

Changes are:

- Gutenberg as a Development Platform => App Platform

- Introduction to the Format API => Formatting Toolbar

- Displaying Notices from Your Plugin or Theme => Notices

- Creating a Sidebar for Your Plugin => Plugin Sidebar
Copy link
Member

@vcanales vcanales left a comment

Choose a reason for hiding this comment

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

Left a small suggestion, but otherwise LGTM!

docs/how-to-guides/format-api/README.md Outdated Show resolved Hide resolved
@mkaz mkaz merged commit f930ace into trunk Nov 19, 2021
@mkaz mkaz deleted the docs/alphabetize-howto branch November 19, 2021 19:11
@github-actions github-actions bot added this to the Gutenberg 12.1 milestone Nov 19, 2021
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.

None yet

3 participants