Docs: Add automated theme.json reference documentation #37569
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
mkaz
requested review from
ajitbohra,
nerrad,
ntwb and
oandregal
as code owners
|
Size Change: 0 B Total Size: 1.13 MB ℹ️ View Unchanged
|
|
Not a code review -the rendered view looks great. |
mkaz
force-pushed
the
docs/36278-gen-theme-ref
branch
2 times, most recently
from
258dff8
to
c5af361
Compare
|
@carolinan Good suggestion, I updated to include the tools that are enabled. @ajlende I added a |
ajlende
reviewed
Dec 23, 2021
There was a problem hiding this comment.
Seems like a solid foundation to build upon!
I'd eventually like to see more descriptions for properties included. Things like formatting for color strings are important and aren't included yet.
Examples are another thing that could be useful. Draft 6 added the examples property that we could leverage; however, like markdownDescription I'd want to do a little research before moving away from draft-04.
- Adds a brief paragraph at top of reference guide linking to how to guide for examples - Adds reference guide to table of contents / manifest
To enrich the automated docs this adds a markdownDescription field for appearanceTools to explain what tools are enabled. You can see the markdownDescription field used in the tsconfig schema here: http:https://json.schemastore.org/tsconfig
Update lint-staged to command to run script to generate theme.json reference prior to checking for changed files. For details fixing similar issue see PR #37613
mkaz
force-pushed
the
docs/36278-gen-theme-ref
branch
from
c5af361
to
627da48
Compare
ajlende
added
the
Backport to WP Minor Release
8 tasks
adamziel
removed
the
Backport to WP Minor Release
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.
Description
Uses the theme.json schema document to generate a reference guide for settings and styles.
Fixes: #36278
Note: This is a stacked PR on top of #37558 that adds npm-run-all command, that should be merged first.
How has this been tested?
See a rendered view of the documentation.
Types of changes
Documentation update.