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

Lots of bikeshed usage issues #965

Closed
annevk opened this issue Aug 29, 2016 · 8 comments
Closed

Lots of bikeshed usage issues #965

annevk opened this issue Aug 29, 2016 · 8 comments
Assignees

Comments

@annevk
Copy link
Member

annevk commented Aug 29, 2016

All 702 instances of <a href="#dfn- are an issue of sorts and would be better if they were expressed correctly without href. If you cannot correctly identify the term you want to use internally, it kinda follows that the external interface (when exporting terms at all) is not ideal either.

@mkruisselbrink
Copy link
Collaborator

These are mostly a leftover of not wanting to make the bikeshed conversion more involved than it already was. But I agree that it would be ideal if the vast majority of these would be replaced with auto-linking links.

@annevk
Copy link
Member Author

annevk commented Nov 21, 2016

More:

  • ASCII case-insensitive is now only defined by Infra, not DOM
  • Lots of variables that need to be annotated with the ignore attribute
  • I don't understand for=resource for the term origin
  • None of the Fetch Standard terms should be in "anchors"

@annevk
Copy link
Member Author

annevk commented Nov 21, 2016

I fixed a simple one in #1008.

@jakearchibald
Copy link
Contributor

I'm going to tackle this - about time I learned the ins & outs of bikeshed.

@jungkees
Copy link
Collaborator

@jakearchibald, sounds great. One thing I'd like to note is while I was trying to resolve bikeshed linking errors, I removed/changed some of the dfn IDs (in this commit: 2e80222). Removing the IDs was mostly around the dfns for IDL attributes and methods, which I thought was needed to use {{Interface/attribute}} notation to reference with. (Not sure whether dropping the IDs wouldn't have been required though.) Changing the IDs was for improving naming consistency, but I think it was not a good idea. Sorry for the confusion. I'll definitely help this cleanup. It seems not breaking the existing urls should be one of the important rules that we should have in mind. Let's sort this out together!

@jakearchibald
Copy link
Contributor

@jungkees yeah, I'm preserving all the IDs that are there now for linking

@tabatkins
Copy link
Member

IDs don't matter; if they're missing, Bikeshed generates them for you, but otherwise it's completely indifferent as to what the ID is. Definitely ideal to keep the existing IDs if they differ from the auto-gen patterns.

Definitely ping me if y'all have any questions about Bikeshed, or if the documention is lacking - I'd love to improve it further with more real-world feedback!

@jakearchibald
Copy link
Contributor

I think we're good here following #1014 right?

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

5 participants