Skip to content

Updated Reflow understanding doc #4055

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

Merged
merged 149 commits into from
Mar 7, 2025
Merged

Conversation

scottaohara
Copy link
Member

@scottaohara scottaohara commented Sep 5, 2024

This initial commit takes the current draft from the google doc that had been worked on for quite some time now, and makes it into a PR for further editing and review.

Not all feedback from the google doc was directly taken/addressed, but there have been additional changes made that attempted to consider a good portion of the unresolved comments.

Marking this PR as a draft, as there is still work to do (and I also need to upload all the new graphics for the examples - and a few examples still need to be created, which are currently marked as comments in the HTML file).

  • identify all the reflow related issues this PR will close or address in some form (see: this comment) - there are others, but this lists at least references all the ones that were considered while working on this PR.
  • add all the new graphics to this PR / render properly (further revisions can be made if people would like different/more consistent examples - but as of now at least all examples for this pr have been created)
  • follow on issue for creating more examples/techniques

The latest updates will be visible via this preview link of the understanding doc

Closes #3121

This initial commit takes the current draft from the google doc that had been worked on for quite some time now, and makes it into a PR for further editing and review.

Not all feedback from the google doc was directly taken/addressed, but there have been additional changes made that attempted to consider a good portion of the unresolved comments.  

Marking this PR as a draft, as there is still work to do (and I also need to upload all the new graphics for the examples - and a few examples still need to be created, which are currently marked as comments in the HTML file)
Copy link

netlify bot commented Sep 5, 2024

Deploy Preview for wcag2 ready!

Name Link
🔨 Latest commit cc708e7
🔍 Latest deploy log https://app.netlify.com/sites/wcag2/deploys/67cb2614694485000807b115
😎 Deploy Preview https://deploy-preview-4055--wcag2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

fix some missing/stray markup end tags
@bruce-usab
Copy link
Contributor

Briefly discussed on backlog call 9/6.

attempt at further addressing issues: 2043 and 366
trying this text out to see what people think.  again i'm wary about saying viewport here since that's not always what is needed.
attempting to briefly address  issue 3311 and 648
@scottaohara
Copy link
Member Author

scottaohara commented Sep 13, 2024

making notes of existing issues addressed with this PR (more to come):

add in the carousel/swimlane examples that were noticed as missing during today's call.

fix the broken animated gif and put it into a disclosure widget so that someone who doesn't want to see the animation can open/close it.
@bruce-usab
Copy link
Contributor

Discussed on backlog call 9/13, thank you @scottaohara! A preview is available but a reminder that the PR is still a work in progress. Most (but not all) content from Google Doc drafting has been pulled in and Scott has placeholders and inline notes-to-self. Looking really good! Outstanding question to @iadawn about replacing 4mb animated gif with an MP4, but where should a multimedia file go? TF would be okay with publishing without (and adding later) as the MVP need not be perfect.

thanks @mfairchild365  for suggestions in simplifying my wordy intro paragraphs.
- wording updates per feedback i received off-github
- added content to replace the "todo" placeholder content for section that introduces the carousel example
- spelling mistakes corrected
- wording modifications to in brief section
- expand tabular data section to call out grid-based UI, incorporating from off-github suggestion to reference "electronic program guides"
part 1 of at least 2.  various wording adjustments for things that people commented could have been clearer.  

comment in the html to add a failing example (line 96)
the images were rather large - so made them a bit smaller to hopefully make the doc feel less 'broken up' by them
move the scoping of exceptions section into the exceptions section (preceded it, and that was weird)

also fixes a paragraph with a missing start tag
@yamahige
Copy link

yamahige commented Mar 5, 2025

@murata2makoto do these pages behave well for scrolling and wrapping? if not - do you have some reference pages we can use that do behave well?

How do you like these small and simple pages:

Please view those pages in the "Full Page" view and shrink the browser window to small. The browser controls the width of the column, sending the overflow characters to the following line and sending the overflow lines to the next column.

@scottaohara
Copy link
Member Author

@mbgower @murata2makoto - I think Mike's assessment is spot on. I went over these two example pages and from what i could tell the first example seemed like it could end up being a good example of how to meet Reflow - as the text that was written vertically changes to be horizontally presented at smaller viewports.

The second example, imo, passes Reflow while not meeting the intent. The page only scrolls vertically - but the text is presented vertically. Someone may have to scroll back and forth (up/down) to read a section of text.... but they don't have to scroll in two dimensions AND the vertical text is not horizontally scrolling (so 320 width applies, not 256 height) - so per the wording of the requirement (which is out of scope for this PR) this passes.

@bruce-usab
Copy link
Contributor

Discussed on backlog call 3/7 and everyone for publishing. TF facilitators discussed after call, to either give more review time or go forward with publishing, and advanced this PR to Fully Reviewed. Thank you @scottaohara and everyone for the feedback!

@mbgower mbgower merged commit 1736b7b into main Mar 7, 2025
5 checks passed
@mbgower mbgower deleted the scottaohara-reflow-understanding-rewrite branch March 7, 2025 18:04
kfranqueiro added a commit that referenced this pull request May 12, 2025
mbgower added a commit that referenced this pull request May 20, 2025
Fixes #4377.

This adds 3 items to the top of the Techniques change log detailing the
1 added technique and 2 removed techniques in #4166. (I have used the
date when #4166 was merged.)

While I was at it, I remembered that #4055 also added new techniques, so
I've added 2 more list items for those.

Initially I had nested/combined list items, but upon further inspection
of the existing items in the change log, I noticed we regularly have
multiple entries with the same date, so I've now flattened the items
added by this PR to one technique per list item.

Tangentially, I also removed punctuation from one line which was
inconsistent with the rest of the top-level list.

@netlify /techniques/

---------

Co-authored-by: Mike Gower <[email protected]>
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.

1.4.10 Reflow needs a preamble