Skip to content

Commit

Permalink
Docs: Move design docs to user interface explanations (#37807)
Browse files Browse the repository at this point in the history
* Move design docs to explanations

* Update table of contents with user interface section

* Update assets reference to developer.wp.org media

* Update link to design resources
  • Loading branch information
mkaz committed Feb 5, 2022
1 parent 1a8971b commit 0fb3492
Show file tree
Hide file tree
Showing 17 changed files with 41 additions and 51 deletions.
2 changes: 1 addition & 1 deletion docs/contributors/design/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ Released under GPL license, made by [Cristel Rossignol](https://twitter.com/cris

## Mockups

Mockup Sketch files are available in [the Design section](/docs/how-to-guides/designers/design-resources.md).
Mockup Sketch files are available in [the User Interface section](/docs/explanations/user-interface/design-resources.md).
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,11 @@ When referring to a block in documentation or UI, use title case for the block t

Blocks should have an identifying icon, ideally using a single color. Try to avoid using the same icon used by an existing block. The core block icons are based on [Material Design Icons](https://material.io/tools/icons/). Look to that icon set, or to [Dashicons](https://developer.wordpress.org/resource/dashicons/) for style inspiration.

![A screenshot of the block library with concise block names](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/designers/assets/blocks-do.png)
![A screenshot of the block library with concise block names](https://developer.wordpress.org/files/2022/01/blocks-do.png)
**Do:**
Use concise block names.

![A screenshot of the block library with long, multi-line block names](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/designers/assets/blocks-dont.png)
![A screenshot of the block library with long, multi-line block names](https://developer.wordpress.org/files/2022/01/blocks-dont.png)
**Don't:**
Avoid long, multi-line block names.

Expand All @@ -96,23 +96,23 @@ Stick to a single imperative sentence with an action + subject format. Examples:
- Introduce new sections and organize content to help visitors (and search engines) understand the structure of your content.
- Create a bulleted or numbered list.

![A screenshot of a short block description](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/designers/assets/block-descriptions-do.png)
![A screenshot of a short block description](https://developer.wordpress.org/files/2022/01/block-descriptions-do.png)
**Do:**
Use a short, simple block description.

![A screenshot of a long block description that includes branding](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/designers/assets/block-descriptions-dont.png)
![A screenshot of a long block description that includes branding](https://developer.wordpress.org/files/2022/01/block-descriptions-dont.png)
**Don't:**
Avoid long descriptions and branding.

### Placeholders

If your block requires a user to configure some options before you can display it, you should provide an instructive placeholder state.

![A screenshot of the Gallery block's placeholder](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/designers/assets/placeholder-do.png)
![A screenshot of the Gallery block's placeholder](https://developer.wordpress.org/files/2022/01/placeholder-do.png)
**Do:**
Provide an instructive placeholder state.

![An example Gallery block placeholder but with intense, distracting colors and no instructions](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/designers/assets/placeholder-dont.png)
![An example Gallery block placeholder but with intense, distracting colors and no instructions](https://developer.wordpress.org/files/2022/01/placeholder-dont.png)
**Don't:**
Avoid branding and relying on the title alone to convey instructions.

Expand All @@ -122,19 +122,19 @@ When unselected, your block should preview its content as closely to the front-e

When selected, your block may surface additional options like input fields or buttons to configure the block directly, especially when they are necessary for basic operation.

![A Google Maps block with inline, always-accessible controls required for the block to function](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/designers/assets/block-controls-do.png)
![A Google Maps block with inline, always-accessible controls required for the block to function](https://developer.wordpress.org/files/2022/01/block-controls-do.png)
**Do:**
For controls that are essential for the operation of the block, provide them directly inside the block edit view.

![A Google Maps block with essential controls moved to the sidebar where they can be contextually hidden](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/designers/assets/block-controls-dont.png)
![A Google Maps block with essential controls moved to the sidebar where they can be contextually hidden](https://developer.wordpress.org/files/2022/01/block-controls-dont.png)
**Don't:**
Do not put controls that are essential to the block in the sidebar, otherwise the block will appear non-functional to mobile users or desktop users who have dismissed the sidebar.

### Advanced Block Settings

The “Block” tab of the Settings Sidebar can contain additional block options and configuration. Keep in mind that a user can dismiss the sidebar and never use it. You should not put critical options in the Sidebar.

![A screenshot of the Paragraph block's advanced settings in the sidebar](https://raw.githubusercontent.com/WordPress/gutenberg/HEAD/docs/how-to-guides/designers/assets/advanced-settings-do.png)
![A screenshot of the Paragraph block's advanced settings in the sidebar](https://developer.wordpress.org/files/2022/01/advanced-settings-do.png)
**Do:**
Because the Drop Cap feature is not necessary for the basic operation of the block, you can put it to the Block tab as optional configuration.

Expand Down
3 changes: 0 additions & 3 deletions docs/how-to-guides/designers/README.md

This file was deleted.

Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed docs/how-to-guides/designers/assets/blocks-do.png
Binary file not shown.
Binary file removed docs/how-to-guides/designers/assets/blocks-dont.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
54 changes: 24 additions & 30 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -167,36 +167,6 @@
"markdown_source": "../docs/how-to-guides/block-tutorial/nested-blocks-inner-blocks.md",
"parent": "block-tutorial"
},
{
"title": "Designer Documentation",
"slug": "designers",
"markdown_source": "../docs/how-to-guides/designers/README.md",
"parent": "how-to-guides"
},
{
"title": "Block Design",
"slug": "block-design",
"markdown_source": "../docs/how-to-guides/designers/block-design.md",
"parent": "designers"
},
{
"title": "User Interface",
"slug": "user-interface",
"markdown_source": "../docs/how-to-guides/designers/user-interface.md",
"parent": "designers"
},
{
"title": "Resources",
"slug": "design-resources",
"markdown_source": "../docs/how-to-guides/designers/design-resources.md",
"parent": "designers"
},
{
"title": "Animation",
"slug": "animation",
"markdown_source": "../docs/how-to-guides/designers/animation.md",
"parent": "designers"
},
{
"title": "Development Platform",
"slug": "platform",
Expand Down Expand Up @@ -1925,6 +1895,30 @@
"markdown_source": "../docs/explanations/architecture/styles.md",
"parent": "architecture"
},
{
"title": "User Interface",
"slug": "user-interface",
"markdown_source": "../docs/explanations/user-interface/README.md",
"parent": "explanations"
},
{
"title": "Block Design",
"slug": "block-design",
"markdown_source": "../docs/explanations/user-interface/block-design.md",
"parent": "user-interface"
},
{
"title": "Animation",
"slug": "animation",
"markdown_source": "../docs/explanations/user-interface/animation.md",
"parent": "user-interface"
},
{
"title": "Resources",
"slug": "design-resources",
"markdown_source": "../docs/explanations/user-interface/design-resources.md",
"parent": "user-interface"
},
{
"title": "Frequently Asked Questions",
"slug": "faq",
Expand Down
15 changes: 7 additions & 8 deletions docs/toc.json
Original file line number Diff line number Diff line change
Expand Up @@ -82,14 +82,6 @@
}
]
},
{
"docs/how-to-guides/designers/README.md": [
{ "docs/how-to-guides/designers/block-design.md": [] },
{ "docs/how-to-guides/designers/user-interface.md": [] },
{ "docs/how-to-guides/designers/design-resources.md": [] },
{ "docs/how-to-guides/designers/animation.md": [] }
]
},
{
"docs/how-to-guides/platform/README.md": [
{
Expand Down Expand Up @@ -278,6 +270,13 @@
{ "docs/explanations/architecture/styles.md": [] }
]
},
{
"docs/explanations/user-interface/README.md": [
{ "docs/explanations/user-interface/block-design.md": [] },
{ "docs/explanations/user-interface/animation.md": [] },
{ "docs/explanations/user-interface/design-resources.md": [] }
]
},
{ "docs/explanations/faq.md": [] },
{ "docs/explanations/glossary.md": [] },
{ "docs/explanations/history.md": [] }
Expand Down

0 comments on commit 0fb3492

Please sign in to comment.