WordPress / WordPress/php-toolkit

Improve Blueprints documentation experience by providing live examples

Open
#42 5 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
PHP
Stars
61
Forks
21
Avg merge
19h 34m
Merged PRs (30d)
7

Description

Apply direct blueprint configurations to the https://playground.wordpress.net/ URL is a very powerful way of using WordPress Playground with tons of applications but unfortunately, the process of creating the JSON configuration in the proper format (encode, remove spaces...) could be a blocker for several developers (a bad formatted character in the URL can make the whole playground not to work as desired), especially for those learning about blueprints.

I think the Blueprints documentation (and use) experience could be improved by a lot by providing live examples of its properties, resource, and steps with a tool such as https://sejas.es/playground ( see example)

I propose the following actions:

cc: @sejas @adamziel

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing Blueprints documentation and the linked sejas.es/playground example, then compare it with the playground.wordpress.net/blueprints URL. Done means migrating the tool and adding live examples for blueprint properties, resources, and steps with links to applied configurations.

Written by the indexing model from the issue text.

Assessment

Tech stack
wordpress
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.