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

Docs: Put more structure to Architecture page #49184

Merged
merged 2 commits into from
Mar 27, 2023
Merged

Docs: Put more structure to Architecture page #49184

merged 2 commits into from
Mar 27, 2023

Conversation

gziolo
Copy link
Member

@gziolo gziolo commented Mar 19, 2023 •
edited
Loading

What?

I got inspired by the input from @Mamaduka about the current structure of Architecture page in the block editor handbook. He mentioned many concepts on the page are missing today on this page. I started looking first how to better structure the document.

The follow-up task would be to discuss what topics we should include on this page.

Why?

How?

@gziolo gziolo added the [Type] Developer Documentation Documentation for developers label Mar 19, 2023
@gziolo gziolo requested a review from priethor March 19, 2023 10:11
priethor
priethor approved these changes Mar 19, 2023
View reviewed changes
Copy link
Contributor

@priethor priethor left a comment

Choose a reason for hiding this comment

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

LGTM as a quick iteration!

docs/explanations/architecture/README.md Show resolved Hide resolved
docs/explanations/architecture/styles.md Show resolved Hide resolved
@github-actions
Copy link

Flaky tests detected in a3dd518.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/4460320626
📝 Reported issues:

@gziolo gziolo marked this pull request as ready for review March 24, 2023 10:57
@gziolo gziolo self-assigned this Mar 24, 2023
@priethor priethor merged commit a725840 into trunk Mar 27, 2023
@priethor priethor deleted the update/docs-architecture branch March 27, 2023 17:29
@github-actions github-actions bot added this to the Gutenberg 15.5 milestone Mar 27, 2023
@Mamaduka Mamaduka mentioned this pull request Mar 27, 2023
Merged
@gziolo
Copy link
Member Author

gziolo commented Mar 29, 2023

I opened a follow-up discussion #49442, so we figure out what's missing on this page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@priethor priethor priethor approved these changes

@kevin940726 kevin940726 kevin940726 left review comments

@oandregal oandregal oandregal left review comments

@aristath aristath aristath approved these changes

@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

Assignees

@gziolo gziolo

Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Milestone
Gutenberg 15.5
Development

Successfully merging this pull request may close these issues.
5 participants
@gziolo @oandregal @aristath @kevin940726 @priethor