Skip to content

Add link check to ensure reference exclude anchors to page title/level-1 headings #2313

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

Open
chalin opened this issue Jun 1, 2025 · 0 comments
Labels
tooling Regarding build, workflows, build-tools, ...

Comments

@chalin
Copy link
Contributor

chalin commented Jun 1, 2025

There is a recurrent problem. GH-repo hosted pages can link to any heading. In such pages, the first heading (which is at level 1) of a page is interpreted as the page title. When the spec gets publish to the OTel website, the level-1 headings are stripped, and instead the title is displayed using specially formatted HTML. The net effect is that there is no anchor in the page for the level-1 heading, because the level 1 heading isn't there anymore.

As an example:

We should find a way to test this. Maybe a custom markdown link check, or even markdown lint check?

@chalin chalin changed the title Add link check to ensure reference excludes anchor to page title/level-1 heading Add link check to ensure reference exclude anchors to page title/level-1 headings Jun 1, 2025
@joaopgrassi joaopgrassi added tooling Regarding build, workflows, build-tools, ... and removed triage:needs-triage labels Jun 4, 2025
@joaopgrassi joaopgrassi moved this from Need triage to Core SemConv issues in DRAFT - SemConv Issue Triage Jun 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tooling Regarding build, workflows, build-tools, ...
Projects
Status: Core SemConv issues
Development

No branches or pull requests

2 participants