Rewrite the spec in Bikeshed#51
Merged
Merged
Conversation
ca73492 to
9e42d17
Compare
63e3367 to
c029017
Compare
7d925fd to
9d61b60
Compare
Collaborator
|
The bikeshed code is indeed more readable. So migrating to it is a win indeed. As a bonus I see we're also getting this IDL Index for free as well. I think the challenge here is ensuring nothing was lost, "corrupted" or altered in the translation. But if you somehow found a way to check this with enough confidence. Great. I spent some minutes comparing the two versions and it looks ok. |
dandrader
approved these changes
Apr 28, 2026
Collaborator
Author
|
Regarding checking, I did the following:
Neither step was completely mistake-proof, of course. But now I have reasonable faith in not having missed anything. |
9d61b60 to
83a2a6a
Compare
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
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.
For a while now I wanted to rewrite this spec in Bikeshed, here it is! This gives us a pre-compiled, static HTML spec that loads way faster and doesn't rely on client-side JS to render.
Most of this is just changing the language while maintaining the same content, however there are a few changes:
|var:Type|syntax. I refactored those into standard prose (Let |var| of type {{Type}}) to keep the hyperlinked types without upsetting the compiler.titleattributes on<aside>tags, so I moved the note titles directly into the markdown text so they're actually visible.Since PR Preview doesn't seem to work well with the exact moment of migration, please see the (thanks to the Spec Generator):
💥 Error: 400 Bad Request 💥
PR Preview failed to build. (Last tried on Apr 28, 2026, 1:58 PM UTC).
More
PR Preview relies on a number of web services to run. There seems to be an issue with the following one:
🚨 Spec Generator - Spec Generator is the web service used to build bikeshed/ReSpec specs
🔗 Related URL
Error output:
This seems to be an issue with the Spec Generator service. PR Preview doesn't manage this service and so has no control over it. If you've identified an issue with it, you can report the issue to the maintainers of Spec Generator directly. Please be courteous. Thank you!
If you don't have enough information above to solve the error by yourself or if the issue doesn't seem related to Spec Generator, you can file an issue with PR Preview.