[create-block] Split documentation into two sections #43718
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ryanwelcher
requested review from
gziolo,
ajitbohra,
juanmaguitar and
fabiankaegy
as code owners
ryanwelcher
added
[Type] Developer Documentation
|
Size Change: +70 B (0%) Total Size: 1.24 MB
ℹ️ View Unchanged
|
gziolo
reviewed
Aug 30, 2022
gziolo
reviewed
Aug 30, 2022
| @@ -24,6 +24,8 @@ _(requires `node` version `14.0.0` or above, and `npm` version `6.14.4` or above | |||
|
|
|||
| It creates a WordPress plugin that you need to [install manually](https://wordpress.org/support/article/managing-plugins/#manual-plugin-installation). | |||
|
|
|||
| [Watch a video introduction to create-block on Learn.wordpress.org](https://learn.wordpress.org/tutorial/using-the-create-block-tool/) | |||
gziolo
reviewed
Aug 30, 2022
gziolo
reviewed
Aug 30, 2022
|
Cool, this is looking great. I will take another look tomorrow 👍🏻 |
juanmaguitar
approved these changes
Aug 31, 2022
gziolo
reviewed
Aug 31, 2022
gziolo
reviewed
Aug 31, 2022
gziolo
approved these changes
Aug 31, 2022
There was a problem hiding this comment.
Excellent addition ❤️
It would be great to document how to add more documentation pages for packages based on this PR. There is more packages that would benefit from similar restructuring. The document that covers contributions to the documentation has even a section about adding new documents:
bph
added
the
Needs Dev Note
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
The intention of the PR is to separate the documentation for create-block into two sections. The first section is on usage and is the default documentation seen when landing on the page. The second is meant to be a child section and focuses on External Templating which is a much different use case. By splitting these out, we increase readability and allow to user to choose what content they need.
In order to facilitate this, I needed to modify the
docgentool to allow for packages to contain their owntoc.jsonfile that is then ingested when generating the mainmanifest.jsonfile.