WordPress / WordPress/Documentation-Issue-Tracker
[HelpHub] Create a block pattern for Block Documentation
Open
@samxmunoz is already working on this.
Since Sep 27, 2022.
[Status] In progress
internal tasks
- Dominant language
- Shell
- Stars
- 109
- Forks
- 73
- PR merge metrics
- No merged PRs in 30d
Description
To ensure block documentation is more consistent and to expedite the process of creating block documentation, we will create a block pattern that includes the core components of most block documentation.
The content that should be included in the pattern would be:
- Intro
- Steps
- Block Toolbar
- Block Settings
and then a docs contributor could simply add that pattern into a new document and fill in the details.
- Create & group the entire documentation so it can be made into a block pattern
- Review with team
- Add to site as a block pattern
Contributor guide
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.
Assessment
This issue has not been assessed yet.