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.

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

Add a documentation page about the block editor settings #54870

Merged
merged 2 commits into from Sep 28, 2023

Conversation

youknowriad
Copy link
Contributor

Related #53874

What?

Just documents some of the most important settings a user can pass as a prop to the BlockEditorProvider component. I think we're still missing the "theme.json" settings and styles from this list but these should be added when we decided on a stable name.

Test the documentation website

cd platform-docs
npm install
npm start

@youknowriad youknowriad added the [Type] Developer Documentation Documentation for developers label Sep 27, 2023
@youknowriad youknowriad requested review from ntsekouras and a team September 27, 2023 13:54
@youknowriad youknowriad self-assigned this Sep 27, 2023
@youknowriad youknowriad requested review from cbravobernal and removed request for a team September 27, 2023 13:54
Copy link
Contributor

@ntsekouras ntsekouras left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

platform-docs/docs/basic-concepts/settings.md Show resolved Hide resolved
platform-docs/docs/basic-concepts/settings.md Outdated Show resolved Hide resolved
Copy link
Contributor

@aaronrobertshaw aaronrobertshaw left a comment

Choose a reason for hiding this comment

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

These docs are looking great, nice work 👍

I spotted a couple of typos so have left inline comments for those and some other minor tweaks

platform-docs/docs/basic-concepts/settings.md Outdated Show resolved Hide resolved
platform-docs/docs/basic-concepts/settings.md Outdated Show resolved Hide resolved
platform-docs/docs/basic-concepts/settings.md Outdated Show resolved Hide resolved
platform-docs/docs/basic-concepts/settings.md Outdated Show resolved Hide resolved
Copy link
Member

@ramonjd ramonjd left a comment

Choose a reason for hiding this comment

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

LGTM!

Left some predictably pedantic suggestions.

"Whether or not" is interesting though - it's mostly used when the outcome is not important. Like, "Whether or not Github allows threads in comments, I'm still going to use it!" :trollface:

platform-docs/docs/basic-concepts/settings.md Outdated Show resolved Hide resolved
platform-docs/docs/basic-concepts/settings.md Outdated Show resolved Hide resolved
platform-docs/docs/basic-concepts/settings.md Outdated Show resolved Hide resolved
@youknowriad youknowriad enabled auto-merge (squash) September 28, 2023 08:07
@youknowriad youknowriad merged commit 46995a2 into trunk Sep 28, 2023
49 checks passed
@youknowriad youknowriad deleted the docs/add-page-about-block-editor-settings branch September 28, 2023 08:54
@github-actions github-actions bot added this to the Gutenberg 16.8 milestone Sep 28, 2023
@bph bph added the Framework Issues related to broader framework topics, especially as it relates to javascript label Oct 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Framework Issues related to broader framework topics, especially as it relates to javascript [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants