Clean up instructions paragraphs #3918
Assignees
Comments
mbgower
pushed a commit
that referenced
this issue
Sep 13, 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](https://deploy-preview-3941--wcag2.netlify.app/techniques/aria/aria24), [SCR39](https://deploy-preview-3941--wcag2.netlify.app/techniques/client-side-script/scr39), [F102](https://deploy-preview-3941--wcag2.netlify.app/techniques/failures/f102), [F105](https://deploy-preview-3941--wcag2.netlify.app/techniques/failures/f105), [G211](https://deploy-preview-3941--wcag2.netlify.app/techniques/general/g211), [G212](https://deploy-preview-3941--wcag2.netlify.app/techniques/general/g212), [G217](https://deploy-preview-3941--wcag2.netlify.app/techniques/general/g217), [G219](https://deploy-preview-3941--wcag2.netlify.app/techniques/general/g219), [2.3.3](https://deploy-preview-3941--wcag2.netlify.app/understanding/animation-from-interactions), [2.5.2](https://deploy-preview-3941--wcag2.netlify.app/understanding/pointer-cancellation), [2.5.3](https://deploy-preview-3941--wcag2.netlify.app/understanding/label-in-name), [2.5.5](https://deploy-preview-3941--wcag2.netlify.app/understanding/target-size-enhanced), - 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](https://deploy-preview-3941--wcag2.netlify.app/techniques/css/c39), [F97](https://deploy-preview-3941--wcag2.netlify.app/techniques/failures/f97), [G211](https://deploy-preview-3941--wcag2.netlify.app/techniques/general/g211), [G217](https://deploy-preview-3941--wcag2.netlify.app/techniques/general/g217), [G218](https://deploy-preview-3941--wcag2.netlify.app/techniques/general/g218), [G220](https://deploy-preview-3941--wcag2.netlify.app/techniques/general/g220), [H100](https://deploy-preview-3941--wcag2.netlify.app/techniques/html/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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Many pages still contain
<p class="instructions>...</p>markup, which originates from the template HTML files and is intended to be replaced. Any such paragraphs found by the build system are automatically removed.Some pages have instructions paragraphs that are either completely empty or still contain the template boilierplate; these are fine to remove.
Other pages, however, seem to have actual information intended to be displayed in these paragraphs, which should instead have only
class="instructions"removed.To illustrate,
G211.htmlcontains examples of both cases; the ones beginning with "Provide" are boilierplate that can be completely removed, while the others are currently being dropped from the build but are probably intended to be included.The text was updated successfully, but these errors were encountered: