WenPai-org/blueprints
7
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
blueprints/docs/assets
History
Exact
Adam Zielinski cf51f27b42
Blueprints Crash Course (#5) 
Launching this Blueprint community space hinges on good materials to
explain what Blueprints are and how developers can work with them.

This PR proposes a few pages to cover:

1. What are Blueprints and how are they useful?
2. How to run Blueprints
3. Building your first Blueprint
4. Debugging Blueprints
5. Developer Tools
6. More Resources

It's a loose interpretation of [the previously proposed
outline](https://github.com/WordPress/blueprints-library/issues/64) that
covers roughly the same topics in a lean way.

## Reviewing

[<kbd> <br>Preview proposed
documentation<br> </kbd>](https://github.com/adamziel/blueprints/blob/blueprints-crash-course/docs/index.md)

cc @flexseth @bph @jonathanbossenger @ironnysh @westnz @justintadlock
@annezazu @bgrgicak @brandonpayton @dmsnell for your opinions. I'd love
to learn:

1. Do you think this covers enough to launch the Community Space and
iterate later?
2. Are these pages clear? Do they do a good job of getting a person from
0 to familiar?
3. What would you change?

## Documentation format

This PR uses Markdown because it's easy to write and can be readily
previewed on GitHub.

In parallel, we're exploring [a Playground-based documentation writing
workflow](https://github.com/adamziel/playground-docs-workflow). It's
not ready for production use yet and I didn't want to block the
community space on these explorations. Once it's finished, these docs
should be easy to migrate.

Closes https://github.com/adamziel/blueprints/issues/2

---------

Co-authored-by: Ronny Shani <63248335+ironnysh@users.noreply.github.com>
Co-authored-by: Birgit Pauli-Haack <birgit.pauli@gmail.com>
2024-04-15 16:32:01 +02:00
..
hello-from-the-dashboard.zip Add an example plugin for the docs 2024-04-05 14:34:11 +02:00
installed-adventurer-theme.png Blueprints Crash Course (#5) 2024-04-15 16:32:01 +02:00
installed-custom-plugin.png Blueprints Crash Course (#5) 2024-04-15 16:32:01 +02:00
schema-autocompletion.png Blueprints Crash Course (#5) 2024-04-15 16:32:01 +02:00