Skip to content

Use new learning resources in Playground documentation - #1276

Merged
adamziel merged 8 commits into
WordPress:trunkfrom
peeranat-dan:peeranat-dan-add-learning-resources
Apr 18, 2024
Merged

Use new learning resources in Playground documentation#1276
adamziel merged 8 commits into
WordPress:trunkfrom
peeranat-dan:peeranat-dan-add-learning-resources

Conversation

@peeranat-dan

Copy link
Copy Markdown
Contributor

What is this PR doing?

What problem is it solving?

  • Add more learning resources and information about WordPress Playground
  • Fix some broken parts of the docs

How is the problem addressed?

From #1258

Testing Instructions

@adamziel

Copy link
Copy Markdown
Collaborator

Lovely @peeranat-dan ! I'd still link to Blueprints 101 but it looks lovely otherwise. It's not a blocker here and I'm happy to merge, LMK how would you like to proceed.

@adamziel adamziel added [Type] Documentation Improvements or additions to documentation [Type] Enhancement New feature or request labels Apr 18, 2024
@peeranat-dan

Copy link
Copy Markdown
Contributor Author

I want to open discussion floor here. There's a word JSON Blueprints and Blueprints API (and even though JSON Blueprints API!!) in the documents. So, I want to ask which word to use to make it consistent throughout the documents.

In my thought, I prefer Blueprints API because in the overview we have Query API, JavaScript API. So Blueprints API fits in the team of the playgrounds APIs. But I want to here from others.

image

@adamziel

Copy link
Copy Markdown
Collaborator

Really good call – let's make the language consistent. I like Blueprints API the most ❤️

@peeranat-dan

Copy link
Copy Markdown
Contributor Author

Lovely @peeranat-dan ! I'd still link to Blueprints 101 but it looks lovely otherwise. It's not a blocker here and I'm happy to merge, LMK how would you like to proceed.

I think it can be added to Links and Resources > Reading materials but I think it's a bit low light. I mean I think not much people will reach here for the first time as the Blueprints 101 was intended.

So after thinking for a while, I decided to add Blueprints 101 at the index page of Blueprints API as new heading to make sure people who read it for the first time knows what is Blueprints API and then jumped into the 101.

@peeranat-dan

Copy link
Copy Markdown
Contributor Author

Really good call – let's make the language consistent. I like Blueprints API the most ❤️

So maybe we can add new issue or I can make another PR to change all JSON Blueprints to Blueprints API?

@adamziel

Copy link
Copy Markdown
Collaborator

Sounds good!

@peeranat-dan

Copy link
Copy Markdown
Contributor Author

I've added the Blueprints 101 at the index page of the Blueprints API. Please let me know if there are any other tasks or updates needed.

@adamziel

Copy link
Copy Markdown
Collaborator

It's lovely @peeranat-dan, thank you!

@adamziel
adamziel merged commit b43a8a6 into WordPress:trunk Apr 18, 2024
@peeranat-dan
peeranat-dan deleted the peeranat-dan-add-learning-resources branch April 18, 2024 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Type] Documentation Improvements or additions to documentation [Type] Enhancement New feature or request

2 participants