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

Benefits sometimes nested under Intent in source files (including template) #3924

Closed
kfranqueiro opened this issue Jun 25, 2024 · 0 comments · Fixed by #3939
Closed

Benefits sometimes nested under Intent in source files (including template) #3924

kfranqueiro opened this issue Jun 25, 2024 · 0 comments · Fixed by #3939
Assignees

Comments

@kfranqueiro
Copy link
Contributor

The Benefits section in Understanding documents is always displayed as a level-2 heading and included in the table of contents, after Intent.

However, a handful of files - including understanding-template.html - instead nest Benefits within Intent, which the build process corrects, pulling it back out to a top-level section with h2.

I'm not sure if there's history behind this discrepancy, but it seems like we ought to make the source files consistent - and at the very least, make the template reflect reality.

A search for <h3>Benefits should find the source files in question (as opposed to <h2>Benefits for ones that fit the current build behavior).

@kfranqueiro kfranqueiro self-assigned this Jul 1, 2024
@w3c w3c deleted a comment from Stephluvsbbymanny Aug 19, 2024
mbgower added a commit that referenced this issue Aug 27, 2024
#3939)

Fixes #3924.

Also addresses the Label in Name instance in #3922.

The diff will be much easier to compare with whitespace ignored
(`?w=1`).

This amends all instances of the Benefits section in Understanding pages
to be a top-level section with a level-2 heading.

I've tested this with both the XSLT and Eleventy build processes to
confirm this doesn't actually change any content, since both build
processes already ensure Benefits is a top-level section with level-2
heading. The one exception is the removal of the redundant first
Benefits section in Understanding 2.5.3 Label in Name, which only
meaningfully affects the XSLT process, as the Eleventy process already
worked around that issue.

Note: I don't know what `identify-changes.html` is supposed to be, but I
updated it regardless; it seems to only contain template boilerplate and
is not linked from anywhere.

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 a pull request may close this issue.

2 participants
@kfranqueiro and others