Skip to content

Commit

Permalink
Docs: Alphabetize the How to Guides section (#35904)
Browse files Browse the repository at this point in the history
* Docs: Alphabetize the How to Guides section

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

* Update docs/how-to-guides/sidebar-tutorial/plugin-sidebar-0.md

Co-authored-by: Carolina Nymark <[email protected]>

* Switch name to Development Platform

* Update title to Formatting Toolbar API

Co-authored-by: Carolina Nymark <[email protected]>
  • Loading branch information
mkaz and carolinan committed Nov 19, 2021
1 parent efc523f commit f930ace
Show file tree
Hide file tree
Showing 6 changed files with 243 additions and 238 deletions.
2 changes: 1 addition & 1 deletion docs/how-to-guides/format-api/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Introduction to the Format API
# Formatting Toolbar API

The purpose of this tutorial is to introduce you to the Format API. The Format API makes it possible for developers to add custom buttons to the formatting toolbar and have them apply a _format_ to a text selection. Bold is an example of a standard button in the formatting toolbar.

Expand Down
2 changes: 1 addition & 1 deletion docs/how-to-guides/notices/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Displaying Notices from Your Plugin or Theme
# Notices

Notices are informational UI displayed near the top of admin pages. WordPress core, themes, and plugins all use notices to indicate the result of an action, or to draw the user's attention to necessary information.

Expand Down
4 changes: 2 additions & 2 deletions docs/how-to-guides/platform/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Gutenberg as a Development Platform
# Development Platform

The Gutenberg Project is not only building a better editor for WordPress, but also creating a platform to build upon. This platform consists of a set of JavaScript packages and tools that you can use in your web application. [View the list packages available on npm](https://www.npmjs.com/org/wordpress).
The Gutenberg Project is not only building a better editor for WordPress, but also creating a platform to build upon. This platform consists of a set of JavaScript packages and tools that you can use in your web application. [View the list of packages available on npm](https://www.npmjs.com/org/wordpress).

## UI Components

Expand Down
8 changes: 6 additions & 2 deletions docs/how-to-guides/sidebar-tutorial/plugin-sidebar-0.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Creating a Sidebar for Your Plugin
# Plugin Sidebar

This tutorial starts with you having an existing plugin setup and ready to add PHP and JavaScript code. Please, refer to [Getting started with JavaScript](/docs/how-to-guides/javascript/) tutorial for an introduction to WordPress plugins and how to use JavaScript to extend the block editor.
How to add a sidebar to your plugin. A sidebar is the region to the far right of the editor. Your plugin can add an additional icon next to the InspectorControls (gear icon) that can be expanded.

![Example sidebar](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/assets/sidebar-up-and-running.png)

**Prerequisite:**: The tutorial assumes you have an existing plugin setup and ready to add PHP and JavaScript code. Please, refer to [Getting started with JavaScript](/docs/how-to-guides/javascript/) tutorial for an introduction to WordPress plugins and how to use JavaScript to extend the block editor.

In the next sections, you're going to create a custom sidebar for a plugin that contains a text control so the user can update a value that is stored in the `post_meta` table.

Expand Down
Loading

0 comments on commit f930ace

Please sign in to comment.