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

Clarification for parent and ancestor hierarchical relationships #53855

Merged

Conversation

colorful-tones
Copy link
Member

@colorful-tones colorful-tones commented Aug 21, 2023

What?

Attempting to offer clarity on the usage of parent and ancestor hierarchical relationship in InnerBlocks nesting.

Some notes:

  • Try to downplay the usage of "child", because I think it is confusing. Especially in headings. Although, I still left a few references.

Why?

Hierarchical relationshiops can be hard to explain.

How?

Change wording.

Testing Instructions

Just a docs change and compare the diff is probably best.

Testing Instructions for Keyboard

Not applicable.

@github-actions
Copy link

Warning: Type of PR label error

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

  • Type-related labels to choose from: [Type] Accessibility (a11y), [Type] Automated Testing, [Type] Breaking Change, [Type] Bug, [Type] Build Tooling, [Type] Code Quality, [Type] Copy, [Type] Developer Documentation, [Type] Enhancement, [Type] Experimental, [Type] Feature, [Type] New API, [Type] Task, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket, Backport from WordPress Core.
  • Labels found: .

Read more about Type labels in Gutenberg.

@colorful-tones colorful-tones changed the title Clarification for parent and ancestor hierarchical relationships Clarification for parent and ancestor hierarchical relationships Aug 21, 2023
@colorful-tones colorful-tones added the [Type] Developer Documentation Documentation for developers label Aug 21, 2023
@colorful-tones
Copy link
Member Author

concise and sometimes verbose

I think that is an oxymoron. 🙃

@colorful-tones
Copy link
Member Author

I'm also wondering if replacing some of the "context" uses with "inheritance" might help. I think the term "context" might get easily confused with Block Context. 🤔

@colorful-tones colorful-tones self-assigned this Aug 21, 2023
Copy link
Member

@fabiankaegy fabiankaegy left a comment

Choose a reason for hiding this comment

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

Thanks for taking a stab at this documentation :) I have raised a few concerns and tried to leave some suggestions. (May be a little messy though)

In general I am not a fan of using the hierarchical relationships reference in this documentation but have left some more detailed notes inline :)

Let me know what you think!

@colorful-tones
Copy link
Member Author

@fabiankaegy All your suggestions were great, and I appreciate the feedback. I had already rewritten some of the content because I'm also writing documentation for ACF Blocks InnerBlocks, and many of these concepts are bouncing around in my head for the best way to try and explain them. I read through your comments. I generally agree with all of your observations. I took another broad pass at the overall approach. I would love another round of feedback. Thanks!

Copy link
Member

@fabiankaegy fabiankaegy left a comment

Choose a reason for hiding this comment

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

I really like the updates you made now :)

@fabiankaegy
Copy link
Member

Haha that was perfect timing. I saw you had pushed a new revision and just finished reading it

Copy link
Member

@ndiego ndiego left a comment

Choose a reason for hiding this comment

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

This looks great. Thanks! 🚢

@ndiego ndiego merged commit bc94b20 into WordPress:trunk Aug 24, 2023
47 checks passed
@github-actions github-actions bot added this to the Gutenberg 16.6 milestone Aug 24, 2023
@colorful-tones colorful-tones deleted the try/innerblock-hierarchy-explanation branch August 24, 2023 14:01
@gziolo
Copy link
Member

gziolo commented Aug 26, 2023

Excellent job rephrasing the subtle differences between these two options. The cool part is that folks can even use both parent and ancestor for a given block if they want to.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants