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: Move design docs to user interface explanations #37807

Merged
merged 4 commits into from
Feb 5, 2022
Merged

Conversation

mkaz
Copy link
Member

@mkaz mkaz commented Jan 9, 2022

Description

The designer documentation is under the How to guides section which is a section intended to explain a specific task. These documents are a general explanation on how the user interface is designed, so this PR moves the docs to the Explanations section.

Additionally, they are renamed to "User Interface" instead of "designers documentation" because they are not role specific docs but information specific, developers and designers both have interest in the user interface. This change is similar to how we moved developer docs to Architecture under explanations.

The goal of this change makes the repository more consistent and easier to find both explanations documents, but additional how to guides since it removes some clutter from there.

A small bonus with this change the image assets used in the moved docs were removed out of the repo to developer.wordpress.org media library.

How has this been tested?

Difficult to confirm since it relies solely on the publishing.

The content of the pages were not changed, just moved. The slugs were also kept the same so WordPress should auto resolve the new locations without needing additional redirects.

Types of changes

Documentation.

  • 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

@mkaz mkaz requested a review from ajitbohra as a code owner January 9, 2022 15:37
@mkaz mkaz added the [Type] Developer Documentation Documentation for developers label Jan 9, 2022
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! 👍

@mkaz mkaz merged commit 0fb3492 into trunk Feb 5, 2022
@mkaz mkaz deleted the docs/design-to-ui branch February 5, 2022 00:07
@github-actions github-actions bot added this to the Gutenberg 12.6 milestone Feb 5, 2022
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

2 participants