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

DevHub link to Documentation, Playground landing page move #728

Closed
courtneyr-dev opened this issue Oct 31, 2023 · 6 comments
Closed

DevHub link to Documentation, Playground landing page move #728

courtneyr-dev opened this issue Oct 31, 2023 · 6 comments
Labels
Accessibility Developer Experience Documentation Improvements or additions to documentation Enhancement New feature or request

Comments

@courtneyr-dev
Copy link

courtneyr-dev commented Oct 31, 2023

Proposing an update to accessing developer docs in https://meta.trac.wordpress.org/ticket/7334.

As a WordPress developer,
I want straightforward access to developer resources when navigating to documentation URLs,
So that I can efficiently find the information I need to enhance my projects.


🌐 Scenario: Seeking Developer Documentation

Given I am a developer looking for documentation and resources,
When I navigate to https://developer.wordpress.org/playground,
Then I expect to find developer documentation and resources directly relevant to my needs.


🔄 Scenario: Encountering WordPress Playground Description

Given I am directed to a landing page describing what WordPress Playground is,
When I am searching for developer documentation,
Then I feel it hinders my journey to finding the necessary resources quickly,
**And ** The Playground description would be better suited at a more general URL.


🔄 Scenario: Redirecting to Top Level for WordPress Playground Introduction

Given the general introductory nature of the content currently at https://developer.wordpress.org/playground,
When I think of where to find such introductory information,
Then I expect it to be located at a top-level domain such as https://WordPress.org/Playground,
And I would appreciate a direct link from the main navigation menu to discover what WordPress Playground is all about easily.


🔄 Scenario: Accessing Developer Documentation

Given the proposal to realign the URLs and content,
When I now navigate to https://developer.wordpress.org/playground,
Then I am redirected to a page with active developer resources and documentation,
And my experience aligns with my expectations as a developer seeking technical information.


🎉 Scenario: Improved Navigation and Logical Content Placement

Given the proposed URL and content realignment,
When I navigate through the WordPress domains,
Then I find a logical, intuitive structure that guides me to the right resources,
And I appreciate the enhanced user experience that saves me time and aligns with my goals as a developer,
So that I am encouraged to explore, learn, and contribute more within the WordPress community.

Related issues

The above work is tracked in these issues:

@courtneyr-dev courtneyr-dev changed the title Developer Documentation DevHub link to Documentation, Playground landing page move Oct 31, 2023
@adamziel adamziel added Documentation Improvements or additions to documentation Enhancement New feature or request Developer Experience Accessibility labels Nov 6, 2023
@adamziel
Copy link
Collaborator

adamziel commented Nov 6, 2023

Good thinking @courtneyr-dev! Let me paraphrase to confirm I understand:

I think that makes a lot of sense. @StevenDufresne what would it take to move the existing https://developer.wordpress.org/playground site to the top-level domain and put a redirect to https://wordpress.github.io/wordpress-playground/ in its place?

@courtneyr-dev
Copy link
Author

Yes @adamziel that's the idea to match the flow of the rest of DevHub going to docs.

@StevenDufresne
Copy link
Contributor

Makes sense to me.

When you are ready, can you split this up into 2 tickets?

@StevenDufresne
Copy link
Contributor

Those two issues are not closed. Please verify.

@adamziel
Copy link
Collaborator

adamziel commented Dec 19, 2023

Looks great to me, thank you so much @StevenDufresne!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accessibility Developer Experience Documentation Improvements or additions to documentation Enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants