-
Notifications
You must be signed in to change notification settings - Fork 4.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
JSON Schema Docgen Rework #63639
JSON Schema Docgen Rework #63639
Conversation
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.
To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
9199754
to
b46fb96
Compare
905f014
to
e00b140
Compare
e00b140
to
5e8ff42
Compare
| --- | --- | --- |--- | | ||
| backgroundImage | boolean | false | | | ||
| backgroundSize | boolean | false | | | ||
| Property | Description | Type | Default | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I much prefer these headings.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is looking good. I deleted the auto generated section and ran node bin/api-docs/gen-theme-reference.mjs
and it restored things as they are.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Compared to previous documents, it is much easier to read, and the document generation logic seems to have been greatly refined.
Here's what the Block Editor Handbook might look like with this PR applied. I tested it by making a temporary change to one table:
What?
Reworks the theme.json reference docgen.
Key features include:
Why?
Split out of #63591 so that both the schema changes and codegen changes can be reviewed independently from one another.
How?
Slow refactoring of the docgen code bit by bit. Check out the commits for details.
Testing Instructions
See that the new docs look correct.
Testing Instructions for Keyboard
N/A
Screenshots or screencast
N/A