speced / speced/respec

Introductory sections require h2-6, despite not needing a header

Open
#4,201 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
JavaScript
Stars
806
Forks
434
Avg merge
1d 21h
Merged PRs (30d)
32

Description

Description of problem

<section class="introductory"> errors on a missing first header element. But the documentation clearly says this is not to be linked from the ToC, which means the header-as-section-title concept shouldn't apply.

Adding class="notoc" does not help.

URL to affected spec or repo:

https://w3c.github.io/PNG-spec/#4Concepts.PNGImageTransformation

What happened (e.g., it crashed)?:

All sections must start with a h2-6 element.
How to fix: Add a h2-6 to the offending section or use a <div>.

Occurred 9 times at:

[<section>](https://w3c.github.io/PNG-spec/#4Concepts.Introduction) element
...

Expected behavior (e.g., it shouldn't crash):
h2-6 tag shouldn't be required for introductory sections

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the introductory-section guidance in the linked Respec documentation with the validation behavior reported for the PNG specification URL. Trace the check producing “All sections must start with a h2-6 element” and add coverage showing that introductory sections do not require a header; done means the affected sections build without that error while ordinary sections retain the requirement.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.