Skip to content

Many updates to the constraints docs#8944

Merged
sfshaza2 merged 11 commits intomainfrom
layout
Jul 17, 2023
Merged

Many updates to the constraints docs#8944
sfshaza2 merged 11 commits intomainfrom
layout

Conversation

@sfshaza2
Copy link
Contributor

Fixes #7701

@Hixie, I'd like your input on this. The original request was to merge the box-constraints page (which you wrote many moons ago) with the Understanding constraints page (written by a third party much more recently.)

I took it even further and I'd like your sign off. This PR:

  • Removes the box-constraints page.
  • Beefs up the Understanding constraints page. Added (with some significant rewording) sections from the OG box-constraints page on Unbounded constraints and Flex sections to the Understanding constraints page. I believe that all the info on the original box-constraints page is now covered.
  • Elevates the "Common framework errors" page. I've set up a redirect so that the previous box-constraints page, now points to the common errors page. (If this all meets with your approval, I'll file a bug to update the tooling to direct to this page.) The common errors page mostly covers layout issues and how to fix them.

That's all I can think of that I've done in this PR. I really appreciate your review!

@goderbauer, if you are the right person to review this, please take a look! Otherwise, please ignore. :D

@sfshaza2 sfshaza2 added the review.tech Awaiting Technical Review label Jun 23, 2023
@github-actions
Copy link

github-actions bot commented Jun 23, 2023

Visit the preview URL for this PR (updated for commit ac8e5c6):

https://flutter-docs-prod--pr8944-layout-ut4no4td.web.app

(expires Mon, 31 Jul 2023 16:56:17 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: d5ba327eec813901cac8396c4f458b02288624ab

@Hixie
Copy link
Contributor

Hixie commented Jun 26, 2023

(This would be easier to review if the whitespace/wrapping changes were done separate from the content changes, so we could more easily notice when content had changed.)

@sfshaza2 sfshaza2 removed the review.tech Awaiting Technical Review label Jul 10, 2023
@atsansone atsansone added the review.await-update Awaiting Updates after Edits label Jul 12, 2023
@sfshaza2 sfshaza2 requested a review from goderbauer July 12, 2023 21:42
@sfshaza2 sfshaza2 added review.tech Awaiting Technical Review and removed review.await-update Awaiting Updates after Edits labels Jul 12, 2023
@sfshaza2
Copy link
Contributor Author

@goderbauer, could you take another look? thx

Copy link
Member

@goderbauer goderbauer left a comment

Choose a reason for hiding this comment

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

Overall this looks good. I just don't know how we can link to the relevant section about unconstrained bounds from the error message now (see comments in the PR).

@sfshaza2 sfshaza2 requested a review from goderbauer July 14, 2023 19:13
Copy link
Member

@goderbauer goderbauer left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@parlough parlough 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 these adjustments and cleanup! Love it!

A few minor fixes and can you also remove box-constraints from the sidenav: https://github.com/flutter/website/blob/main/src/_data/sidenav.yml#L83-L84

@parlough parlough added st.RFM.% Ready to merge or land with minor changes. No further review needed. and removed review.tech Awaiting Technical Review labels Jul 14, 2023
@sfshaza2 sfshaza2 removed the st.RFM.% Ready to merge or land with minor changes. No further review needed. label Jul 17, 2023
@sfshaza2 sfshaza2 merged commit efe85fd into main Jul 17, 2023
@sfshaza2 sfshaza2 deleted the layout branch July 17, 2023 17:08
@Hixie
Copy link
Contributor

Hixie commented Jul 17, 2023

Just for posterity when we're following breadcrumbs later, what was the conclusion for what we want to do with the error message that points to these pages? Did we add a redirect for people with old versions of Flutter? Are we updating newer versions of Flutter?

@parlough
Copy link
Member

https://flutter.dev/layout still redirects to the unbounded constraints section, but we should consider adding a new, more specific redirect to switch to since flutter.dev/layout seems like a valuable path to have open eventually.

\cc @sfshaza2

@sfshaza2
Copy link
Contributor Author

Yes, I'd like to add a new specific redirect. I plan to file an issue.

@sfshaza2
Copy link
Contributor Author

Filed: flutter/flutter#130805

sfshaza2 added a commit that referenced this pull request Jul 19, 2023
Tooling (will) point to flutter.dev/unbounded-constraints, which is a
shortcut for a longer link.

Related PR:  #8944
and:              flutter/flutter#130805
atsansone pushed a commit to atsansone/website that referenced this pull request Jul 19, 2023
Fixes flutter#7701

@Hixie, I'd like your input on this. The original request was to merge
the box-constraints page (which you wrote many moons ago) with the
Understanding constraints page (written by a third party much more
recently.)

I took it even further and I'd like your sign off. This PR:

- Removes the box-constraints page.
- Beefs up the Understanding constraints page. Added (with some
significant rewording) sections from the OG box-constraints page on
Unbounded constraints and Flex sections to the Understanding constraints
page. I _believe_ that all the info on the original box-constraints page
is now covered.
- Elevates the "Common framework errors" page. I've set up a redirect so
that the previous box-constraints page, now points to the common errors
page. (If this all meets with your approval, I'll file a bug to update
the tooling to direct to this page.) The common errors page mostly
covers layout issues and how to fix them.

That's all I can think of that I've done in this PR. I really appreciate
your review!

@goderbauer, if you are the right person to review this, please take a
look! Otherwise, please ignore. :D
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Merge 'Dealing with box constraints' page with 'Understanding constraints' page

5 participants