Page MenuHomeFreeBSD

doc: fix HTML validation errors
ClosedPublic

Authored by vladlen on Sat, Sep 26, 9:56 AM.
Tags
Referenced Files
F174438029: D60037.id187731.diff
Sat, Oct 3, 5:30 AM
F174425722: D60037.id.diff
Sat, Oct 3, 2:57 AM
F174422228: D60037.id187729.diff
Sat, Oct 3, 2:13 AM
F174365083: D60037.id.diff
Fri, Oct 2, 5:20 PM
F174363009: D60037.diff
Fri, Oct 2, 4:59 PM
Unknown Object (File)
Thu, Oct 1, 2:58 PM
Unknown Object (File)
Wed, Sep 30, 11:58 PM
Unknown Object (File)
Tue, Sep 29, 1:19 PM
Subscribers
None

Details

Summary

All documentation pages failed HTML validation due to a duplicate
id="TableOfContents" (side + mobile TOC) and an invalid heading level
(h1 → h3 skip in both TOC labels and in the Resources block).

Fix:

  • Replaced the <h3> labels with <p class="toc-title">/<p class="resources-title">, as already done for the footer, to remove the heading-level skip.
  • Renamed the mobile TOC id to "TableOfContentsMobile" to eliminate the duplicate id.
  • Updated CSS: new .toc-title/.resources-title rules use var(--size-550), bold weight, line-height 1.3 and matching paddings, so the labels keep the exact look of the previous <h3>.

Checked locally: both TOCs render as before and the pages now pass
W3C validation in this code (still they have other validation errors).

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

vladlen created this revision.

Thank you so much for taking care of this

documentation/themes/beastie/assets/styles/documentation.scss
304

indentation, can be fixed on the commit

This revision is now accepted and ready to land.Sat, Sep 26, 9:57 AM
This revision was automatically updated to reflect the committed changes.