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

Spec source file uses "section autolinks" incorrectly, they'll start breaking #158

Open
tabatkins opened this issue Jan 14, 2020 · 0 comments

Comments

@tabatkins
Copy link

The .bs source uses section autolinks ([[spec#heading-id]]) for a lot of places where it intends to just link to definitions in those specs. This is incorrect markup; if the specs' heading data isn't in Bikeshed, Bikeshed just throws up its hands and assumes you know what you're linking to. (Which means that the links are fragile/unsafe, with no guarantee that the ID exists at all in the destination document.)

However, these specs were in Bikeshed, I just wasn't processing the spec names properly; now that I've fixed that, Bikeshed is (correctly) reporting that those IDs don't correspond to any headings in the spec, and no longer generating a link. The next time you (or your CI) generates the spec, you'll get a number of fatal errors, and the output will lose several links.

Please replace these with proper autolinks, such as [=term here=] or {{Foo/method()}}: see https://tabatkins.github.io/bikeshed/#autolink-microsyntax for guidance on syntax, or feel free to contact me in IRC at Freenode#whatwg or W3C#css.

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

No branches or pull requests

1 participant