Skip to content
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.

Sign up for GitHub

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

Jump to bottom

JSON Schema Docgen Rework #63868

Merged
merged 43 commits into from
Jul 23, 2024
Merged

JSON Schema Docgen Rework #63868

merged 43 commits into from
Jul 23, 2024

Conversation

ajlende
Copy link
Contributor

@ajlende ajlende commented Jul 23, 2024 •
edited
Loading

Reopened #63639 so that it could be merged in the correct order after #63591.

What?

Reworks the theme.json reference docgen.

Key features include:

  • Descriptions for styles and settings properties.
  • Reworked type serialization to remove the props heading for styles and settings.
  • Better types everywhere in the document.
  • Details for settings and styles.
  • The useRootPaddingAwareAlignments top-level property returns.
  • Cleaner code.

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

@ajlende ajlende added the [Type] Developer Documentation Documentation for developers label Jul 23, 2024
@ajlende ajlende requested a review from scruffian July 23, 2024 16:10
@ajlende ajlende self-assigned this Jul 23, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Jul 23, 2024 •
edited
Loading

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 props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: ajlende <ajlende@git.wordpress.org>
Co-authored-by: scruffian <scruffian@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Base automatically changed from update/json-schema-cleanup to trunk July 23, 2024 16:26
@ajlende
Inline table generation
fe14ed8
@ajlende
Create functino for document generation
d0109f8
@ajlende
Rename and reorganize
c1f9a23
@ajlende
Add settings and styles descriptions
4d107eb
@ajlende
Remove template type because it should be obvious
bc1d7c5
@ajlende
Revamp type gen
7e8f9b6
@ajlende
Update type generation
3d68361
@ajlende
Rename and refactor functions
962bcfa
@ajlende
Update JSDoc
3397383
@ajlende
Update comments
ed95c0c
@ajlende
Stringify default value
85ee58f
@ajlende
Add descriptions for styles and settings
8ec5a66
@ajlende
Fix falsy default values
11f0a98
@ajlende
Lowercase settings and styles
cac9d56
@ajlende
Update strings
708cb82
@ajlende
Refactor main
9e16589
@ajlende
Clarify doc comment
f16d362
@ajlende
Add comment for why one line of description
1b91fef
@ajlende
Update how top-level only settings are selected and rendered
99bb337
@ajlende
Select styles directly instead of through definitions
2926476
@ajlende
Update variable names
743cddf
@ajlende
Reorder patterns type in docs
8c2c101
@ajlende ajlende force-pushed the update/json-schema-codegen-rework branch from 858e561 to 8c2c101 Compare July 23, 2024 16:43
scruffian
scruffian approved these changes Jul 23, 2024
View reviewed changes
Copy link
Contributor

@scruffian scruffian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ajlende ajlende enabled auto-merge (squash) July 23, 2024 16:50
@ajlende ajlende merged commit 4cf4ec3 into trunk Jul 23, 2024
61 checks passed
@ajlende ajlende deleted the update/json-schema-codegen-rework branch July 23, 2024 17:18
@github-actions github-actions bot added this to the Gutenberg 18.9 milestone Jul 23, 2024
westonruter added a commit that referenced this pull request Jul 23, 2024
@westonruter
Merge branch 'trunk' into try/interactivity-lazy-hydration
63f7145 
* trunk: (2604 commits)
  Update "Versions in WordPress" page (#63869)
  SelectControl: Fix hover/focus color in wp-admin (#63855)
  Add margin-bottom lint rules for RangeControl (#63821)
  JSON Schema Docgen Rework (#63868)
  JSON Schema Reorganization and Fixes (#63591)
  DataForm: Add a simple story for the DataForm component (#63840)
  Quick Edit: Support bulk selection (#63841)
  Update dataviews docs (#63860)
  Bump the github-actions group across 1 directory with 4 updates (#63808)
  Add unit tests for the gutenberg_render_block_core_post_title() function.
  Make hover block outlines not present in Distraction Free (#63819)
  DataViews: Rename the header property of fields to label (#63843)
  Fix: Error while Calling edit-site getCurrentTemplateTemplateParts selector (#63818)
  Revert "Update HeightControl component to label inputs" (#63839)
  Zoom out: hide vertical toolbar when block is not full width (#63650)
  Latest comments: Add color block support (#63419)
  Core Data: Remove leftover 'todo' comment (#63842)
  Tabs: keep full opacity of focus ring on disabled tabs (#63754)
  Fix selected row styles in table layout (#63811)
  Align checkbox, radio, and toggle input design (#63490)
  ...
@t-hamano t-hamano mentioned this pull request Oct 24, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@scruffian scruffian scruffian approved these changes

@ntwb ntwb Awaiting requested review from ntwb ntwb is a code owner

@nerrad nerrad Awaiting requested review from nerrad nerrad is a code owner

@ajitbohra ajitbohra Awaiting requested review from ajitbohra ajitbohra is a code owner

@ryanwelcher ryanwelcher Awaiting requested review from ryanwelcher

@juanmaguitar juanmaguitar Awaiting requested review from juanmaguitar juanmaguitar is a code owner

@fabiankaegy fabiankaegy Awaiting requested review from fabiankaegy fabiankaegy is a code owner

@ndiego ndiego Awaiting requested review from ndiego ndiego is a code owner

Assignees

@ajlende ajlende

Labels
[Type] Developer Documentation Documentation for developers
Projects
Automattic team Ignite's project board
Archived in project
Milestone
Gutenberg 18.9
Development

Successfully merging this pull request may close these issues.
2 participants
@ajlende @scruffian