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

Updated Reflow understanding doc #4055

Draft
wants to merge 120 commits into
base: main
Choose a base branch
from

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)
  • add all the new graphics to this PR / render properly
  • identify additional examples / techniques that could be created as additional future improvements

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 44bcdd6
🔍 Latest deploy log https://app.netlify.com/sites/wcag2/deploys/67a63b01b7f4f40008d1f7a3
😎 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
understanding/21/reflow.html Outdated Show resolved Hide resolved
@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
understanding/21/reflow.html Outdated Show resolved Hide resolved
scottaohara and others added 5 commits February 6, 2025 20:20
pulling in some of @fstrr's edits. 

see #4055 (comment) for more context
instead of pulling in the edits @fstrr made, i'm removing the initial paragraph that talked about carousels and swimlanes.  The term swimlanes was confusing, and the paragraph wasn't as necessary with the preceding paragraph edits and the fact that carousels are a highlighted example only a couple paragraphs later.

other revisions to the carousel example section per the decision to remove the term swimlanes

see - #4055 (comment)
@gundulaniemann
Copy link
Contributor

We discussed a lot what should definitely be linearized, and one of the main example was an online newspaper.
So it kind of drills down to masonry layout (the one used in facebook).
I agree this is the most annoying and hardest to orient, and I suggest to explicitly mention it.

So, I suggest to add the following in some appropriate place in the understanding document:
"Masonry layout (like used in newspapers) and grid layout (like used for tiles or cards) should be linearized."

@mbgower mbgower assigned fstrr and unassigned mbgower Feb 7, 2025
@detlevhfischer
Copy link
Contributor

masonry layout

Hearing the term for the first time. Is this a commonly used and understood thing? Explain?

@fstrr
Copy link
Contributor

fstrr commented Feb 7, 2025

Masonry layout has been around for several years, initially using JavaScript to create the layout (for example: Cascading grid layout library). It's slowly being standardized (for example: Masonry layout).

@bruce-usab
Copy link
Contributor

Discussed on backlog call 2/7. @gundulaniemann offered to make one more editorial pass. TF goal is to send to AG by next Friday (2/17).

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