๐๐ง๏ผstart each health file at heading level one - #885
Merged
Conversation
Every one of these documents opened at `##` and hung its sections off that at `###`, so the document title was a second-level heading and nothing was ever first-level. MD002 and MD041 are both disabled here, which is why it went unremarked. Consumers that lift the title out of the document and render it as the page heading are left with sections at `###` beneath an `h1`, skipping a level โ openinf.github.io does exactly that, and the W3C validator fails it. Promoting everything one level fixes that at the source and leaves these reading as ordinary documents on GitHub. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
OpenINFbot
changed the title
OpenINFbot
approved these changes
Aug 10, 2026
DerekNonGeneric
added a commit
to OpenINF/openinf.github.io
that referenced
this pull request
Aug 10, 2026
Running compile.siteifyHealthFiles has been broken for a while. It is only invoked when the health files are missing, so nothing ran it and nobody noticed its output no longer built. Permalinks came out without a trailing slash, so Eleventy wrote an extensionless file instead of `<permalink>/index.html` and failed the build outright. Every committed copy carries the slash, so these had been repaired by hand at some point and the task never learned. The title heading was also stripped with a global regex, harmless only while `##` appeared once per file. OpenINF/.github#885 moves those documents to an `h1` title with `##` sections, at which point the old pattern would have taken all nine of CONTRIBUTING.md's section headings along with the title. It now strips the first heading only, and reads either level so the import works before and after that lands. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request Purpose
This PR contains the following:
Testing
Heading levels in Markdown; no code path to cover. Verified each file now has exactly one
h1(soMD025stays satisfied) and that only heading lines are touched.Breaking Changes
Anchors are generated from heading text, not level, so existing deep links keep working.
Description
Every health file opened at
##and hung its sections off that at###:So the document title was a second-level heading and nothing in the file was ever first-level.
MD002andMD041are both disabled in.markdownlint.jsonc, which is why this went unremarked.This bites any consumer that lifts the title out of the document to render as the page heading, because the sections are then two levels below it. openinf.github.io does exactly that โ it imports these five files as pages and renders the title as the page's
h1, leaving:which the W3C validator rejects:
The heading โh3โ โฆ follows the heading โh1โ โฆ, skipping 1 heading level.Promoting everything one level fixes it at the source. Each file now opens at
#, sections sit at##, and the two subsections inCONTRIBUTING.mdat###โ which is also just how a standalone document is normally written, so these read no worse on GitHub.CODE_OF_CONDUCT.md###CONTRIBUTING.md##, 9ร###, 2ร#####, 9ร##, 2ร###SECURITY.md##, 2ร####, 2ร##SUPPORT.md##, 1ร####, 1ร##VISION.md###Important
Please hold this until openinf.github.io#1785 is ready to land with it. That site's importer currently strips titles with a global regex (
/^## (.*)\n\n/gm), which is harmless only while##appears once per file. Once sections are##, running that importer unchanged would strip every section heading out of the imported copy. The site PR fixes the importer to strip only the title; merging these together avoids the window.Follows #883 and #884.
List of any relevant issue numbers: none