WordPress / WordPress/php-toolkit
Improve Blueprints documentation experience by providing live examples
Nobody has claimed this yet.
- 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:
- Migrate https://sejas.es/playground to https://playground.wordpress.net/blueprints
- Provide examples of properties, resources, and steps of blueprints with links to these configurations applied to https://playground.wordpress.net/blueprints
cc: @sejas @adamziel
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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