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

Instructions paragraph cleanup #3941

Merged
merged 3 commits into from
Sep 13, 2024
Merged

Instructions paragraph cleanup #3941

merged 3 commits into from
Sep 13, 2024

Conversation

kfranqueiro
Copy link
Contributor

@kfranqueiro kfranqueiro commented Jul 1, 2024

Resolves #3918.

There are multiple commits in this PR, each grouping a subset of removals:

  • Removals of entire <p class="instructions"> paragraphs having no effect on output
    • Some of these contained boilerplate from the original techniques or understanding template; others had content redundant of information that the build system automatically generates. (There was one instance of the latter in label-in-name.html that did not even have class="instructions", and was thus already causing repetition of auto-generated content.)
    • Previews: ARIA24, SCR39, F102, F105, G211, G212, G217, G219, 2.3.3, 2.5.2, 2.5.3, 2.5.5,
  • Removals of class="instructions" from paragraphs with custom content that should not have had this class; these were previously absent from build output but will now be present.
    • To be clear, this PR does not add any content that was not already previously authored and reviewed.
    • Previews: C39, F97, G211, G217, G218, G220, H100

In cases where removal of these paragraphs clearly yielded an empty section, I have removed the entire section. (In some cases, these sections were already commented out.) This overlaps a bit with #3927; I have updated the log there to exclude what's already handled in this PR.

Note: as part of this PR, I have removed identify-changes.html and interruptions-minimum.html from understanding/21, as both of these seemed to be unused and largely contained template boilerplate. These removals do not affect build output at all.

@w3cbot
Copy link

w3cbot commented Jul 1, 2024

kfranqueiro marked as non substantive for IPR from ash-nazg.

Copy link

netlify bot commented Aug 23, 2024

Deploy Preview for wcag2 ready!

Name Link
🔨 Latest commit 08fdff6
🔍 Latest deploy log https://app.netlify.com/sites/wcag2/deploys/66ce3cecacfe220008f65746
😎 Deploy Preview https://deploy-preview-3941--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.

These paragraphs are automatically generated by the build process,
and should not be manually added to source files.

In the case of ARIA24, the build will automatically generate
a more descriptive paragraph for ARIA techniques than the one being removed.
(These paragraphs would be pruned by the build process, but shouldn't be)
@mbgower mbgower merged commit 5ce3361 into main Sep 13, 2024
5 checks passed
@mbgower mbgower deleted the kgf-instructions-cleanup branch September 13, 2024 14:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clean up instructions paragraphs
4 participants